MailJet (publicador independiente) (versión preliminar)
Colección completa de todos los puntos de conexión y métodos disponibles públicamente para la API de Mailjet
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | Clement OLIVIER |
| URL | https://stuffandtacos.azurewebsites.net/ |
| Correo Electrónico | clement@carfup.com |
| Metadatos del conector | |
|---|---|
| Publicador | Clement Olivier |
| Sitio web | https://www.mailjet.com/ |
| Directiva de privacidad | https://www.mailjet.com/security-privacy/ |
| Categorías | Marketing; Comunicación |
Creación de una conexión
El conector admite los siguientes tipos de autenticación:
| Predeterminado | Parámetros para crear una conexión. | Todas las regiones | No se puede compartir |
Predeterminado
Aplicable: Todas las regiones
Parámetros para crear una conexión.
Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.
| Nombre | Tipo | Description | Obligatorio |
|---|---|---|---|
| Clave de API/inicio de sesión | securestring | La clave de API o el inicio de sesión emitidos por MailJet | Cierto |
| Secreto de API | securestring | El secreto de API/PassWord emitido por MailJet | Cierto |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Actualizar borrador de campaña |
Actualizar un borrador de campaña existente |
| Actualizar contacto |
Actualizar el nombre y el estado de exclusión especificados por el usuario de un contacto específico |
| Actualizar lista de contactos |
Actualice una lista de contactos específica cambiando su nombre o estado de eliminación. |
| Crear borrador de campaña |
Cree un borrador de campaña. Los objetos Newsletter y CampaignDraft se diferencian por los valores EditMode. |
| Crear contacto |
Agregue un nuevo contacto único a la lista global de contactos y seleccione su estado de exclusión. |
| Crear lista de contactos |
Crear una nueva lista de contactos |
| Eliminar lista de contactos |
Eliminar una lista de contactos |
| Enviar correo electrónico v3 |
Envío de un mensaje de correo electrónico a través de Send API v3 |
| Enviar correo electrónico v3.1 |
Envío de un mensaje de correo electrónico a través de Send API v3.1 |
| Obtener borrador de campaña por identificador |
Obtener un borrador de campaña específico y sus detalles de configuración |
| Obtener borrador de campañas |
Obtener todos los borradores de campaña y su configuración |
| Obtener contacto por identificador |
Recuperar un contacto específico |
| Obtener contactos |
Recuperar una lista de todos los contactos. Incluye información sobre el estado de contacto y la creación o las marcas de tiempo de actividad. |
| Obtener datos de contacto por identificador |
Recuperar todas las propiedades y los valores respectivos asociados a un contacto específico |
| Obtener datos de contactos |
Obtener información sobre todos los contactos y los valores de propiedad asociados a ellos |
| Obtener estadísticas de contactos |
Recuperar una lista de estadísticas generales de entrega y participación agregadas, agrupadas por contacto |
| Obtener información de mensajes |
Recuperar información de envío, tamaño o correo no deseado sobre todos los mensajes |
| Obtener información general sobre la campaña |
Obtener detalles generales y estadísticas para todos los borradores, objetos AB Testing o campañas enviadas |
| Obtener lista de contactos por identificador |
Recupere los detalles de una lista de contactos específica: nombre, recuento de suscriptores, marca de tiempo de creación, estado de eliminación. |
| Obtener listas de contactos |
Recupere los detalles de todas las listas de contactos: nombre, recuento de suscriptores, marca de tiempo de creación, estado de eliminación. |
| Recibir mensajes |
Obtener una lista de mensajes con información específica sobre el tipo de contenido, el seguimiento, el envío y la entrega |
Actualizar borrador de campaña
Actualizar un borrador de campaña existente
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de borrador
|
draft_ID | True | integer |
Identificador numérico único del borrador de campaña que desea actualizar |
|
Tipo de contenido
|
Content-Type | string |
Tipo de contenido |
|
|
Current
|
Current | integer |
Current |
|
|
Modo de edición
|
EditMode | string |
Modo de edición para el borrador de campaña. |
|
|
IsStarred
|
IsStarred | boolean |
Está estrellado |
|
|
IsTextPartIncluded
|
IsTextPartIncluded | boolean |
Elemento de texto incluido |
|
|
ReplyEmail
|
ReplyEmail | string |
Correo electrónico de respuesta |
|
|
SenderName
|
SenderName | string |
Nombre del remitente |
|
|
TemplateID
|
TemplateID | integer |
Identificador de plantilla |
|
|
Title
|
Title | string |
Title |
|
|
ContactsListID
|
ContactsListID | string |
Id. de lista de contactos |
|
|
ContactsListAlt
|
ContactsListAlt | string |
Alt de lista de contactos |
|
|
Configuración regional
|
Locale | True | string |
Configuración regional |
|
SegmentationID
|
SegmentationID | integer |
Id. de segmentación |
|
|
SegmentationAlt
|
SegmentationAlt | string |
Alt de segmentación |
|
|
Remitente
|
Sender | string |
Remitente |
|
|
SenderEmail
|
SenderEmail | string |
Correo electrónico del remitente |
|
|
Asunto
|
Subject | True | string |
Asunto |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
Count | integer |
Contar |
|
Data
|
Data | array of CampaignDraftResponse |
Data |
|
Total
|
Total | integer |
Total |
Actualizar contacto
Actualizar el nombre y el estado de exclusión especificados por el usuario de un contacto específico
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID de contacto
|
contact_ID | True | string |
Identificador numérico único del contacto que desea actualizar |
|
IsExcludedFromCampaigns
|
IsExcludedFromCampaigns | boolean |
Indica si el contacto se agrega a la lista de exclusión de campañas o no. |
|
|
Nombre
|
Name | string |
Nombre seleccionado por el usuario para este contacto |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
Count | integer |
Contar |
|
Data
|
Data | array of ContactResponse |
Data |
|
Total
|
Total | integer |
Total |
Actualizar lista de contactos
Actualice una lista de contactos específica cambiando su nombre o estado de eliminación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de lista
|
list_ID | True | string |
Identificador numérico único asignado a esta lista de contactos |
|
Nombre
|
Name | True | string |
Nombre especificado por el usuario para esta lista de contactos (debe ser único) |
|
IsDeleted
|
IsDeleted | boolean |
Cuando es true, la lista de contactos se marcará como Eliminada. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
Count | integer |
Contar |
|
Data
|
Data | array of ContactsListResponse |
Data |
|
Total
|
Total | integer |
Total |
Crear borrador de campaña
Cree un borrador de campaña. Los objetos Newsletter y CampaignDraft se diferencian por los valores EditMode.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Current
|
Current | integer |
Current |
|
|
Modo de edición
|
EditMode | string |
Modo de edición para el borrador de campaña. |
|
|
IsStarred
|
IsStarred | boolean |
Está estrellado |
|
|
IsTextPartIncluded
|
IsTextPartIncluded | boolean |
Elemento de texto incluido |
|
|
ReplyEmail
|
ReplyEmail | string |
Correo electrónico de respuesta |
|
|
SenderName
|
SenderName | string |
Nombre del remitente |
|
|
TemplateID
|
TemplateID | integer |
Identificador de plantilla |
|
|
Title
|
Title | string |
Title |
|
|
ContactsListID
|
ContactsListID | string |
Id. de lista de contactos |
|
|
ContactsListAlt
|
ContactsListAlt | string |
Alt de lista de contactos |
|
|
Configuración regional
|
Locale | True | string |
Configuración regional |
|
SegmentationID
|
SegmentationID | integer |
Id. de segmentación |
|
|
SegmentationAlt
|
SegmentationAlt | string |
Alt de segmentación |
|
|
Remitente
|
Sender | string |
Remitente |
|
|
SenderEmail
|
SenderEmail | string |
Correo electrónico del remitente |
|
|
Asunto
|
Subject | True | string |
Asunto |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
Count | integer |
Contar |
|
Data
|
Data | array of CampaignDraftResponse |
Data |
|
Total
|
Total | integer |
Total |
Crear contacto
Agregue un nuevo contacto único a la lista global de contactos y seleccione su estado de exclusión.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
IsExcludedFromCampaigns
|
IsExcludedFromCampaigns | string |
Indica si el contacto se agrega a la lista de exclusión de campañas o no. |
|
|
Nombre
|
Name | string |
Nombre seleccionado por el usuario para este contacto |
|
|
Correo Electrónico
|
True | string |
Dirección de correo electrónico de contacto |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
Count | integer |
Contar |
|
Data
|
Data | array of ContactResponse |
Data |
|
Total
|
Total | integer |
Total |
Crear lista de contactos
Crear una nueva lista de contactos
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre
|
Name | True | string |
Nombre especificado por el usuario para esta lista de contactos (debe ser único) |
|
IsDeleted
|
IsDeleted | boolean |
Cuando es true, la lista de contactos se marcará como Eliminada. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
Count | integer |
Contar |
|
Data
|
Data | array of ContactsListResponse |
Data |
|
Total
|
Total | integer |
Total |
Eliminar lista de contactos
Eliminar una lista de contactos
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de lista
|
list_ID | True | string |
Id. de lista |
Enviar correo electrónico v3
Envío de un mensaje de correo electrónico a través de Send API v3
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Desde correo electrónico
|
FromEmail | True | string |
Desde correo electrónico |
|
Nombre del remitente
|
FromName | string |
Nombre del remitente |
|
|
Remitente
|
Sender | boolean |
Remitente |
|
|
Correo electrónico de receta
|
string |
Correo Electrónico |
||
|
Nombre del recetario
|
Name | string |
Nombre |
|
|
Para enviar correo electrónico
|
To | True | string |
Para enviar correo electrónico |
|
Correo electrónico cc
|
Cc | string |
Correo electrónico cc |
|
|
Correo electrónico de cco
|
Bcc | string |
Correo electrónico de cco |
|
|
Asunto
|
Subject | string |
Línea de asunto del correo electrónico |
|
|
Elemento de texto
|
Text-part | string |
Elemento de texto |
|
|
Elemento HTML
|
Html-part | string |
Elemento HTML |
|
|
Filename
|
Filename | string |
Nombre completo del archivo (incluida la extensión de archivo) |
|
|
Content-type
|
Content-type | string |
Define el tipo de contenido que se envía mediante un tipo MIME. |
|
|
Content
|
Content | string |
Contenido codificado en Base64 del archivo adjunto |
|
|
Filename
|
Filename | string |
Filename |
|
|
Content-type
|
Content-type | string |
Content-type |
|
|
Content
|
Content | string |
Content |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Sent
|
Sent | array of object |
Sent |
|
Correo Electrónico
|
Sent.Email | string |
Correo Electrónico |
|
MessageID
|
Sent.MessageID | integer |
Id. de mensaje |
|
MessageUUID
|
Sent.MessageUUID | string |
UUID del mensaje |
Enviar correo electrónico v3.1
Envío de un mensaje de correo electrónico a través de Send API v3.1
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Desde correo electrónico
|
True | string |
Dirección de correo electrónico desde |
|
|
Nombre del remitente
|
Name | string |
Nombre del remitente |
|
|
Para enviar correo electrónico
|
string |
Dirección de correo electrónico del destinatario |
||
|
Para asignar un nombre
|
Name | string |
Nombre del destinatario |
|
|
Correo electrónico del remitente
|
string |
Dirección de correo electrónico usada para enviar el mensaje |
||
|
Nombre del remitente
|
Name | string |
Nombre seleccionado por el usuario para la dirección de correo electrónico del remitente |
|
|
Correo electrónico de replyto
|
string |
Correo electrónico de replyto |
||
|
Nombre de ReplyTo
|
Name | string |
Nombre de ReplyTo |
|
|
Correo electrónico cc
|
string |
Correo electrónico cc |
||
|
Nombre cc
|
Name | string |
Nombre cc |
|
|
Correo electrónico de cco
|
string |
Correo electrónico de cco |
||
|
Nombre cco
|
Name | string |
Nombre cco |
|
|
Asunto
|
Subject | string |
Línea de asunto del correo electrónico. |
|
|
TextPart
|
TextPart | string |
Proporciona la parte texto del mensaje |
|
|
HTMLPart
|
HTMLPart | string |
Proporciona la parte HTML del mensaje. |
|
|
TemplateID
|
TemplateID | integer |
Identificador numérico único de la plantilla que se va a usar como contenido de correo electrónico. |
|
|
Filename
|
Filename | string |
Nombre completo del archivo (incluida la extensión de archivo) |
|
|
Content-type
|
Content-type | string |
Define el tipo de contenido que se envía mediante un tipo MIME. |
|
|
Content
|
Base64Content | string |
Contenido codificado en Base64 del archivo adjunto |
|
|
SandboxMode
|
SandboxMode | boolean |
Modo de espacio aislado |
|
|
AdvanceErrorHandling
|
AdvanceErrorHandling | boolean |
Control avanzado de errores |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Messages
|
Messages | array of object |
Messages |
|
Estado
|
Messages.Status | string |
Estado |
|
Errors
|
Messages.Errors | array of object |
Errors |
|
ErrorIdentifier
|
Messages.Errors.ErrorIdentifier | string |
Identificador de error |
|
ErrorCode
|
Messages.Errors.ErrorCode | string |
Código de error |
|
Código de estado
|
Messages.Errors.StatusCode | integer |
Código de estado |
|
Mensaje de error
|
Messages.Errors.ErrorMessage | string |
Mensaje de error |
|
ErrorRelatedTo
|
Messages.Errors.ErrorRelatedTo | string |
Error relacionado con |
|
CustomID
|
Messages.CustomID | string |
Identificador personalizado |
|
Para
|
Messages.To | array of object |
Para |
|
Correo Electrónico
|
Messages.To.Email | string |
Correo Electrónico |
|
MessageUUID
|
Messages.To.MessageUUID | string |
UUID del mensaje |
|
MessageID
|
Messages.To.MessageID | integer |
Id. de mensaje |
|
MessageHref
|
Messages.To.MessageHref | string |
Message Href |
|
CC
|
Messages.Cc | array of object |
CC |
|
Correo Electrónico
|
Messages.Cc.Email | string |
Correo Electrónico |
|
MessageUUID
|
Messages.Cc.MessageUUID | string |
UUID del mensaje |
|
MessageID
|
Messages.Cc.MessageID | integer |
Id. de mensaje |
|
MessageHref
|
Messages.Cc.MessageHref | string |
Message Href |
|
Bcc
|
Messages.Bcc | array of object |
Bcc |
|
Correo Electrónico
|
Messages.Bcc.Email | string |
Correo Electrónico |
|
MessageUUID
|
Messages.Bcc.MessageUUID | string |
UUID del mensaje |
|
MessageID
|
Messages.Bcc.MessageID | integer |
Id. de mensaje |
|
MessageHref
|
Messages.Bcc.MessageHref | string |
Message Href |
Obtener borrador de campaña por identificador
Obtener un borrador de campaña específico y sus detalles de configuración
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de borrador
|
draft_ID | True | integer |
Identificador numérico único del borrador de campaña que desea recuperar. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
Count | integer |
Contar |
|
Data
|
Data | array of CampaignDraftResponse |
Data |
|
Total
|
Total | integer |
Total |
Obtener borrador de campañas
Obtener todos los borradores de campaña y su configuración
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
Count | integer |
Contar |
|
Data
|
Data | array of CampaignDraftResponse |
Data |
|
Total
|
Total | integer |
Total |
Obtener contacto por identificador
Recuperar un contacto específico
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID de contacto
|
contact_ID | True | string |
Identificador numérico único del contacto que desea recuperar |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
Count | integer |
Contar |
|
Data
|
Data | array of ContactResponse |
Data |
|
Total
|
Total | integer |
Total |
Obtener contactos
Recuperar una lista de todos los contactos. Incluye información sobre el estado de contacto y la creación o las marcas de tiempo de actividad.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Campaña
|
Campaign | integer |
Recupera solo los contactos de destino de este identificador de campaña. |
|
|
ContactsList
|
ContactsList | integer |
Recupera solo los contactos que forman parte de este identificador de lista de contactos. |
|
|
IsExcludedFromCampaigns
|
IsExcludedFromCampaigns | boolean |
Recuperará solo los contactos que se han agregado a la lista de exclusión para los correos electrónicos de marketing. |
|
|
Limit
|
Limit | integer |
Limitar la respuesta a un número seleccionado de objetos devueltos |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
Count | integer |
Contar |
|
Data
|
Data | array of ContactResponse |
Data |
|
Total
|
Total | integer |
Total |
Obtener datos de contacto por identificador
Recuperar todas las propiedades y los valores respectivos asociados a un contacto específico
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
ID de contacto
|
contactID | True | integer |
Identificador numérico único para el contacto, cuyas propiedades desea recuperar |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
Count | integer |
Contar |
|
Data
|
Data | array of ContactDataResponse |
Data |
|
Total
|
Total | integer |
Total |
Obtener datos de contactos
Obtener información sobre todos los contactos y los valores de propiedad asociados a ellos
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Campaña
|
Campaign | integer |
Recupera una lista de valores de propiedad de contacto solo para los contactos, que recibieron correos electrónicos de este identificador de campaña. |
|
|
Correo electrónico de contacto
|
ContactEmail | string |
Recupera una lista de valores de propiedad de contacto solo para el contacto con esta dirección de correo electrónico. |
|
|
Id. de lista de contactos
|
ContactsList | integer |
Recupera una lista de valores de propiedad de contacto solo para los contactos que forman parte de este identificador de lista de contactos. |
|
|
Fields
|
Fields | string |
Se pueden especificar varias propiedades separandolas con comas |
|
|
Última actividad en
|
LastActivityAt | string |
Recupera una lista de valores de propiedad de contacto solo para los contactos. |
|
|
Limit
|
Limit | integer |
Limitar la respuesta a un número seleccionado de objetos devueltos |
|
|
Desplazar
|
OffSet | integer |
Recuperar una lista de objetos a partir de un desplazamiento determinado |
|
|
Solo recuento
|
countOnly | boolean |
Solo recuento de retornos. |
|
|
Ordenar
|
Sort | string |
Especificar un nombre de propiedad para este parámetro de consulta para ordenar los objetos en Datos |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
Count | integer |
Contar |
|
Data
|
Data | array of ContactDataResponse |
Data |
|
Total
|
Total | integer |
Total |
Obtener estadísticas de contactos
Recuperar una lista de estadísticas generales de entrega y participación agregadas, agrupadas por contacto
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
Count | integer |
Contar |
|
Data
|
Data | array of object |
Data |
|
BlockedCount
|
Data.BlockedCount | integer |
Recuento de bloqueos |
|
BouncedCount
|
Data.BouncedCount | integer |
Recuento de rebotes |
|
ClickedCount
|
Data.ClickedCount | integer |
Recuento en el que se ha clic |
|
ContactID
|
Data.ContactID | integer |
ID de contacto |
|
DeferredCount
|
Data.DeferredCount | integer |
Recuento diferido |
|
DeliveredCount
|
Data.DeliveredCount | integer |
Recuento entregado |
|
HardbouncedCount
|
Data.HardbouncedCount | integer |
Recuento de hardbounced |
|
LastActivityAt
|
Data.LastActivityAt | date-time |
Última actividad en |
|
MarketingContacts
|
Data.MarketingContacts | integer |
Contactos de marketing |
|
OpenedCount
|
Data.OpenedCount | integer |
Recuento abierto |
|
ProcessedCount
|
Data.ProcessedCount | integer |
Recuento procesado |
|
QueuedCount
|
Data.QueuedCount | integer |
Recuento en cola |
|
SoftbouncedCount
|
Data.SoftbouncedCount | integer |
Recuento de rebotes suaves |
|
SpamComplaintCount
|
Data.SpamComplaintCount | integer |
Recuento de quejas de correo no deseado |
|
UnsubscribedCount
|
Data.UnsubscribedCount | integer |
Recuento cancelado |
|
UserMarketingContacts
|
Data.UserMarketingContacts | integer |
Contactos de marketing de usuarios |
|
WorkFlowExitedCount
|
Data.WorkFlowExitedCount | integer |
Recuento de salidas de WorkFlow |
|
Total
|
Total | integer |
Total |
Obtener información de mensajes
Recuperar información de envío, tamaño o correo no deseado sobre todos los mensajes
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
CampaignID
|
CampaignID | integer |
Recupera información solo sobre los mensajes que forman parte de esta campaña. |
|
|
ContactsList
|
ContactsList | integer |
Recupera información solo sobre los mensajes enviados a esta lista de contactos. |
|
|
CustomCampaign
|
CustomCampaign | integer |
Recupera información solo sobre los mensajes que forman parte de una campaña con el identificador personalizado especificado. |
|
|
De
|
From | string |
Recupera información solo sobre los mensajes enviados desde la dirección de correo electrónico del remitente especificada. |
|
|
FromDomain
|
FromDomain | string |
Recupera información solo sobre los mensajes enviados desde el dominio remitente especificado. |
|
|
FromID
|
FromID | integer |
Recupera información solo sobre los mensajes enviados desde el identificador de remitente especificado. |
|
|
FromTS
|
FromTS | date-time |
Recupera solo los mensajes enviados después de la marca de tiempo especificada. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
Count | integer |
Contar |
|
Data
|
Data | array of MessageInformationResponse |
Data |
|
Total
|
Total | integer |
Total |
Obtener información general sobre la campaña
Obtener detalles generales y estadísticas para todos los borradores, objetos AB Testing o campañas enviadas
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
Count | integer |
Contar |
|
Data
|
Data | array of object |
Data |
|
ClickedCount
|
Data.ClickedCount | integer |
Recuento en el que se ha clic |
|
DeliveredCount
|
Data.DeliveredCount | integer |
Recuento entregado |
|
EditMode
|
Data.EditMode | string |
Modo de edición |
|
EditType
|
Data.EditType | string |
Editar tipo |
|
identificación
|
Data.ID | integer |
identificación |
|
IDType
|
Data.IDType | string |
Tipo de identificador |
|
OpenedCount
|
Data.OpenedCount | integer |
Recuento abierto |
|
ProcessedCount
|
Data.ProcessedCount | integer |
Recuento procesado |
|
SendTimeStart
|
Data.SendTimeStart | integer |
Inicio de hora de envío |
|
Estrellado
|
Data.Starred | boolean |
Estrellado |
|
Estado
|
Data.Status | integer |
Estado |
|
Asunto
|
Data.Subject | string |
Asunto |
|
Title
|
Data.Title | string |
Title |
|
Total
|
Total | integer |
Total |
Obtener lista de contactos por identificador
Recupere los detalles de una lista de contactos específica: nombre, recuento de suscriptores, marca de tiempo de creación, estado de eliminación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador numérico único
|
list_ID | True | string |
Identificador numérico único asignado a esta lista de contactos. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
Count | integer |
Contar |
|
Data
|
Data | array of ContactsListResponse |
Data |
|
Total
|
Total | integer |
Total |
Obtener listas de contactos
Recupere los detalles de todas las listas de contactos: nombre, recuento de suscriptores, marca de tiempo de creación, estado de eliminación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Dirección
|
Address | string |
Recupera solo la lista de contactos con la dirección única especificada creada por Mailjet. |
|
|
Excluir id.
|
ExcludeID | integer |
Excluye la lista de contactos con el identificador especificado de la respuesta. |
|
|
¿Se elimina ?
|
IsDeleted | boolean |
Cuando sea true, recuperará solo las listas eliminadas. Cuando sea false, recuperará listas que no se eliminan. |
|
|
Nombre
|
Name | string |
Recupera solo la lista con el nombre seleccionado por el usuario especificado. |
|
|
Limit
|
Limit | integer |
Limite la respuesta a un número seleccionado de objetos devueltos. |
|
|
Desplazar
|
OffSet | integer |
Recupere una lista de objetos a partir de un desplazamiento determinado. |
|
|
Solo recuento
|
countOnly | boolean |
Devuelve solo o no las filas de recuento. |
|
|
Ordenar
|
Sort | string |
Especifique un nombre de propiedad para este parámetro de consulta para ordenar los objetos de Data. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
Count | integer |
Contar |
|
Data
|
Data | array of ContactsListResponse |
Data |
|
Total
|
Total | integer |
Total |
Recibir mensajes
Obtener una lista de mensajes con información específica sobre el tipo de contenido, el seguimiento, el envío y la entrega
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Contacto
|
Contact | integer |
Recupera solo los mensajes enviados al identificador de contacto especificado. |
|
|
CustomID
|
CustomID | integer |
Recupera solo los mensajes etiquetados con el CustomID especificado. |
|
|
Destino
|
Destination | integer |
Recupera solo los mensajes enviados al identificador de destino especificado. |
|
|
FromTS
|
FromTS | date-time |
Recupera solo los mensajes enviados después de la marca de tiempo especificada. |
|
|
Limit
|
Limit | integer |
Limitar la respuesta a un número seleccionado de objetos devueltos |
|
|
FromType
|
FromType | integer |
|
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
Count | integer |
Contar |
|
Data
|
Data | array of MessageResponse |
Data |
|
Total
|
Total | integer |
Total |
Definiciones
MessageResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
ArrivedAt
|
ArrivedAt | string |
Llegado a |
|
AttachmentCount
|
AttachmentCount | integer |
Recuento de datos adjuntos |
|
AttemptCount
|
AttemptCount | integer |
Recuento de intentos |
|
CampaignID
|
CampaignID | integer |
Identificador de campaña |
|
ContactAlt
|
ContactAlt | string |
Alt de contacto |
|
ContactID
|
ContactID | integer |
ID de contacto |
|
Retraso
|
Delay | number |
Retraso |
|
DestinationID
|
DestinationID | integer |
Id. de destino |
|
FilterTime
|
FilterTime | integer |
Tiempo de filtro |
|
identificación
|
ID | integer |
identificación |
|
IsClickTracked
|
IsClickTracked | boolean |
Se hace clic en El seguimiento |
|
IsHTMLPartIncluded
|
IsHTMLPartIncluded | boolean |
Se incluye el elemento HTML |
|
IsOpenTracked
|
IsOpenTracked | boolean |
Se realiza un seguimiento abierto |
|
IsTextPartIncluded
|
IsTextPartIncluded | boolean |
Elemento de texto incluido |
|
IsUnsubTracked
|
IsUnsubTracked | boolean |
Is Unsubscription Tracked |
|
MessageSize
|
MessageSize | integer |
Tamaño del mensaje |
|
SenderID
|
SenderID | integer |
Id. de remitente |
|
SpamassassinScore
|
SpamassassinScore | number |
Spamassassin Score |
|
SpamassRules
|
SpamassRules | string |
Reglas de Spamass |
|
StateID
|
StateID | integer |
Id. de estado |
|
StatePermanent
|
StatePermanent | boolean |
Estado permanente |
|
Estado
|
Status | string |
Estado |
|
Asunto
|
Subject | string |
Asunto |
|
Identificador Único Universal (UUID)
|
UUID | string |
Identificador Único Universal (UUID) |
MessageInformationResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
CampaignID
|
CampaignID | integer |
Identificador de campaña |
|
ClickTrackedCount
|
ClickTrackedCount | integer |
Haga clic en Recuento de seguimiento. |
|
ContactID
|
ContactID | integer |
ID de contacto |
|
CreatedAt
|
CreatedAt | date-time |
Creado en |
|
identificación
|
ID | integer |
identificación |
|
MessageSize
|
MessageSize | integer |
Tamaño del mensaje |
|
OpenTrackedCount
|
OpenTrackedCount | integer |
Recuento de seguimiento abierto |
|
QueuedCount
|
QueuedCount | integer |
Recuento en cola |
|
SendEndAt
|
SendEndAt | string |
Enviar al final al |
|
SentCount
|
SentCount | integer |
Recuento enviado |
|
SpamAssassinScore
|
SpamAssassinScore | number |
Puntuación de asesino de correo no deseado |
ContactResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
IsExcludedFromCampaigns
|
IsExcludedFromCampaigns | boolean |
Se excluye deCampaigns |
|
Nombre
|
Name | string |
Nombre |
|
CreatedAt
|
CreatedAt | date-time |
Creado en |
|
DeliveredCount
|
DeliveredCount | integer |
Recuento entregado |
|
Correo Electrónico
|
string |
Correo Electrónico |
|
|
ExclusionFromCampaignsUpdatedAt
|
ExclusionFromCampaignsUpdatedAt | string |
Exclusión de campañas actualizadas en |
|
identificación
|
ID | integer |
identificación |
|
IsOptInPending
|
IsOptInPending | boolean |
Is OptIn Pending |
|
IsSpamComplaining
|
IsSpamComplaining | boolean |
¿Se queja de correo no deseado? |
|
LastActivityAt
|
LastActivityAt | date-time |
Última actividad en |
|
LastUpdateAt
|
LastUpdateAt | date-time |
Última actualización en |
ContactsListResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Nombre
|
Name | string |
Nombre |
|
Dirección
|
Address | string |
Dirección |
|
CreatedAt
|
CreatedAt | date-time |
Creado en |
|
identificación
|
ID | integer |
identificación |
|
SubscriberCount
|
SubscriberCount | integer |
Recuento de suscriptores |
CampaignDraftResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
AXFraction
|
AXFraction | integer |
Fracción de AX |
|
AXFractionName
|
AXFractionName | string |
Nombre de fracción de AX |
|
AXTesting
|
AXTesting | string |
Pruebas de AX |
|
Current
|
Current | integer |
Current |
|
EditMode
|
EditMode | string |
Modo de edición |
|
IsStarred
|
IsStarred | boolean |
Está estrellado |
|
IsTextPartIncluded
|
IsTextPartIncluded | boolean |
¿Se incluye TextPart? |
|
ReplyEmail
|
ReplyEmail | string |
Correo electrónico de respuesta |
|
SenderName
|
SenderName | string |
Nombre del remitente |
|
TemplateID
|
TemplateID | integer |
Identificador de plantilla |
|
Title
|
Title | string |
Title |
|
CampaignID
|
CampaignID | integer |
Identificador de campaña |
|
ContactsListID
|
ContactsListID | integer |
Id. de lista de contactos |
|
CreatedAt
|
CreatedAt | date-time |
Creado en |
|
DeliveredAt
|
DeliveredAt | date-time |
Entregado en |
|
identificación
|
ID | integer |
identificación |
|
Configuración regional
|
Locale | string |
Configuración regional |
|
ModifiedAt
|
ModifiedAt | date-time |
Modificado en |
|
Preset
|
Preset | string |
Preset |
|
SegmentationID
|
SegmentationID | integer |
Id. de segmentación |
|
Remitente
|
Sender | string |
Remitente |
|
SenderEmail
|
SenderEmail | string |
Correo electrónico del remitente |
|
Estado
|
Status | integer |
Estado |
|
Asunto
|
Subject | string |
Asunto |
|
URL
|
Url | string |
URL |
|
Utilizado
|
Used | boolean |
Utilizado |
ContactDataResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
ContactID
|
ContactID | integer |
Identificador numérico único para este contacto |
|
Data
|
Data | array of |
Matriz JSON que contiene propiedades de contacto y sus valores |
|
identificación
|
ID | integer |
Identificador numérico único para el objeto Data de este contacto |
|
MethodCollection
|
MethodCollection | string |
MethodCollection |