Moosend (publicador independiente) (versión preliminar)
La última plataforma de automatización de marketing por correo electrónico y software de marketing que no interrumpirá su banco. Con cientos de plantillas de up-to-date entre las que elegir, las campañas de marketing de correo electrónico se vestirán para el éxito.
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 | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| Correo Electrónico | ttaylor@hitachisolutions.com |
| Metadatos del conector | |
|---|---|
| Publicador | Troy Taylor |
| Sitio web | https://moosend.com/ |
| Directiva de privacidad | https://www.sitecore.com/trust/privacy-policy |
| Categorías | Mercadotecnia |
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 | securestring | La clave de API de esta API | Cierto |
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Actualización de una campaña de borrador |
Actualiza las propiedades de una campaña AB de borrador existente en su cuenta. No se pueden actualizar campañas no borradores. Ignore (opción de campaña dividida AB) si desea crear una campaña regular. |
| Actualizar un campo personalizado |
Actualiza las propiedades de un campo personalizado existente en la lista de distribución de correo especificada. |
| Actualizar un suscriptor |
Actualiza un suscriptor en la lista de distribución de correo especificada. |
| Actualizar una lista de correo |
Actualiza las propiedades de una lista de distribución de correo existente. |
| Agregar suscriptor |
Agrega un nuevo suscriptor a la lista de distribución de correo especificada. |
| Agregar varios suscriptores |
Agrega varios suscriptores en una lista de distribución de correo con una sola llamada. |
| Anular la programación de una campaña |
Quita una fecha y hora programadas definidas previamente de una campaña, de modo que se entregará inmediatamente si ya están en cola o cuando se envíen. |
| Cancelar la suscripción de suscriptor de la lista de distribución de correo |
Cancela la suscripción de un suscriptor de la lista de distribución de correo especificada. |
| Cancelar la suscripción del suscriptor de la cuenta |
Cancela la suscripción de un suscriptor de la cuenta. |
| Clonación de una campaña existente |
Crea una copia exacta de una campaña existente. La nueva campaña se crea como borrador. |
| Creación de un campo personalizado |
Crea un nuevo campo personalizado en la lista de distribución de correo especificada. |
| Crear una campaña de borrador |
Crea una nueva campaña de borrador en su cuenta. |
| Crear una lista de correo |
Crea una nueva lista de correo vacía en su cuenta. |
| Eliminación de una campaña |
Elimina una campaña de su cuenta, borrador o incluso enviada. |
| Eliminación de varios suscriptores |
Quita una lista de suscriptores de la lista de distribución de correo especificada de forma permanente. |
| Eliminar una lista de distribución de correo |
Elimina una lista de correo de su cuenta. |
| Enviar una campaña |
Envía una campaña de borrador existente a todos los destinatarios especificados en su lista de correo. La campaña se envía inmediatamente. |
| Obtención de los detalles del remitente |
Devuelve información del remitente especificado identificado por su dirección de correo electrónico. |
| Obtención del resumen de la campaña de prueba ab |
Proporciona un resumen básico de los resultados de una campaña de prueba ab enviada, por separado para cada versión (A y B), como el número de destinatarios, se abre, hace clic, rebota, cancela la suscripción, reenvía, etc. |
| Obtener actividad de vínculo |
Devuelve una lista con los vínculos de campaña y cuántos clics han realizado los destinatarios, ya sea únicos o totales. |
| Obtener actividad por ubicación |
Devuelve un informe detallado de la campaña que abre (único y total) por país. |
| Obtener campañas |
Devuelve una lista de todas las campañas de tu cuenta con información detallada. |
| Obtener detalles de la campaña |
Devuelve un conjunto completo de propiedades que describen la campaña solicitada en detalle. |
| Obtener detalles de la lista de distribución de correo |
Recupera los detalles de una lista de distribución de correo determinada. |
| Obtener estadísticas de campaña |
Recupera una lista detallada de estadísticas de una campaña determinada basada en actividades como correos electrónicos enviados, abiertos, devueltos, clics de vínculo, etc. |
| Obtener remitentes |
Recupera una lista de los remitentes activos de su cuenta. |
| Obtener resumen de campaña |
Recupera un resumen básico de los resultados de cualquier campaña enviada, como el número de destinatarios, se abre, hace clic, rebota, cancela la suscripción, reenvía, etc. hasta la fecha. |
| Obtener suscriptor por dirección de correo electrónico |
Busca un suscriptor con la dirección de correo electrónico especificada en la lista de correo especificada. |
| Obtener suscriptor por identificador |
Busca un suscriptor con el identificador único especificado en la lista de distribución de correo especificada. |
| Obtener suscriptores |
Recupera una lista de todos los suscriptores de una lista de correo determinada. |
| Obtener todas las listas de distribución de correo activas |
Recupera una lista de las listas de correo activas en su cuenta. |
| Programación de una campaña |
Asigna una fecha y hora programadas en las que se entregará la campaña. |
| Prueba de una campaña |
Envía un correo electrónico de prueba de una campaña de borrador a una lista de direcciones de correo electrónico que especifique para obtener una vista previa. |
| Quitar un campo personalizado |
Quita una definición de campo personalizada de la lista de correo especificada. |
| Quitar un suscriptor |
Quita permanentemente un suscriptor de la lista de distribución de correo especificada. |
Actualización de una campaña de borrador
Actualiza las propiedades de una campaña AB de borrador existente en su cuenta. No se pueden actualizar campañas no borradores. Ignore (opción de campaña dividida AB) si desea crear una campaña regular.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de campaña
|
CampaignId | True | string |
Identificador de la campaña. |
|
Nombre
|
Name | string |
Nombre. |
|
|
Asunto
|
Subject | string |
El asunto. |
|
|
Correo electrónico del remitente
|
SenderEmail | string |
Dirección de correo electrónico del remitente. |
|
|
Responder al correo electrónico
|
ReplyToEmail | string |
Respuesta a la dirección de correo electrónico. |
|
|
Confirmación al correo electrónico
|
ConfirmationToEmail | string |
Confirmación de la dirección de correo electrónico. |
|
|
Ubicación web
|
WebLocation | string |
Ubicación web. |
|
|
Id. de lista de distribución de correo
|
MailingListID | string |
Identificador de la lista de distribución de correo. |
|
|
Id. de segmento
|
SegmentID | string |
Identificador del segmento. |
|
|
Es AB
|
IsAB | string |
es AB. |
|
|
Tipo de campaña AB
|
ABCampaignType | string |
Tipo de campaña AB. |
|
|
Ubicación web B
|
WebLocationB | string |
Ubicación web B. |
|
|
Horas que se van a probar
|
HoursToTest | string |
Horas que se van a probar. |
|
|
Porcentaje de lista
|
ListPercentage | string |
Porcentaje de lista. |
|
|
Tipo de selección ab winner
|
ABWinnerSelectionType | string |
Tipo de selección ab ganador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
Context
|
Context | string |
Contexto. |
Actualizar un campo personalizado
Actualiza las propiedades de un campo personalizado existente en la lista de distribución de correo especificada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de lista de distribución de correo
|
MailingListId | True | string |
Identificador de la lista de distribución de correo. |
|
Id. de campo personalizado
|
CustomFieldId | True | string |
Identificador de campo personalizado. |
|
Nombre
|
Name | string |
Nombre. |
|
|
Tipo de campo personalizado
|
CustomFieldType | string |
Tipo de campo personalizado. |
|
|
Options
|
Options | string |
Las opciones. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
Context
|
Context | string |
Contexto. |
Actualizar un suscriptor
Actualiza un suscriptor en la lista de distribución de correo especificada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de lista de distribución de correo
|
MailingListId | True | string |
Identificador de la lista de distribución de correo. |
|
Identificador de suscriptor
|
SubscriberId | True | string |
Identificador del suscriptor. |
|
Nombre
|
Name | string |
Nombre. |
|
|
Tiene doble participación externa
|
HasExternalDoubleOptIn | boolean |
Si tiene doble participación externa. |
|
|
Correo Electrónico
|
string |
Dirección de correo electrónico. |
||
|
Campos personalizados
|
CustomFields | array of string |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
identificación
|
Context.ID | string |
Identificador. |
|
Nombre
|
Context.Name | string |
Nombre. |
|
Correo Electrónico
|
Context.Email | string |
Dirección de correo electrónico. |
|
Creadas el
|
Context.CreatedOn | string |
Cuando se crea. |
|
Actualizado al
|
Context.UpdatedOn | string |
Cuando se actualiza. |
|
Cancelación de suscripción
|
Context.UnsubscribedOn | string |
Cuando se cancela la suscripción. |
|
Cancelación de la suscripción del identificador
|
Context.UnsubscribedFromID | string |
El identificador que ha cancelado la suscripción. |
|
Tipo de suscripción
|
Context.SubscribeType | integer |
Tipo de suscripción. |
|
Método Subscribe
|
Context.SubscribeMethod | integer |
Método de suscripción. |
|
Campos personalizados
|
Context.CustomFields | array of object | |
|
Id. de campo personalizado
|
Context.CustomFields.CustomFieldID | string |
Identificador de campo personalizado. |
|
Nombre
|
Context.CustomFields.Name | string |
Nombre. |
|
Importancia
|
Context.CustomFields.Value | string |
Valor. |
|
Se ha quitado activado
|
Context.RemovedOn | string |
Cuando se quita. |
Actualizar una lista de correo
Actualiza las propiedades de una lista de distribución de correo existente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de lista de distribución de correo
|
MailingListId | True | string |
Identificador de la lista de distribución de correo. |
|
Nombre
|
Name | string |
Nombre. |
|
|
Página de confirmación
|
ConfirmationPage | string |
Página de confirmación. |
|
|
Redireccionamiento después de cancelar la suscripción a la página
|
RedirectAfterUnsubscribePage | string |
Redirección después de cancelar la suscripción. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
Context
|
Context | string |
Contexto. |
Agregar suscriptor
Agrega un nuevo suscriptor a la lista de distribución de correo especificada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de lista de distribución de correo
|
MailingListId | True | string |
Identificador de la lista de distribución de correo. |
|
Nombre
|
Name | string |
Nombre. |
|
|
Correo Electrónico
|
string |
Dirección de correo electrónico. |
||
|
Tiene doble participación externa
|
HasExternalDoubleOptIn | boolean |
Si tiene doble participación externa. |
|
|
Campos personalizados
|
CustomFields | array of string |
Campos personalizados. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
identificación
|
Context.ID | string |
Identificador. |
|
Nombre
|
Context.Name | string |
Nombre. |
|
Correo Electrónico
|
Context.Email | string |
Dirección de correo electrónico. |
|
Creadas el
|
Context.CreatedOn | string |
Cuando se crea. |
|
Actualizado al
|
Context.UpdatedOn | string |
Cuando se actualiza. |
|
Cancelación de suscripción
|
Context.UnsubscribedOn | string |
Cuando se cancela la suscripción. |
|
Cancelación de la suscripción del identificador
|
Context.UnsubscribedFromID | string |
El identificador que ha cancelado la suscripción. |
|
Tipo de suscripción
|
Context.SubscribeType | integer |
Tipo de suscripción. |
|
Método Subscribe
|
Context.SubscribeMethod | integer |
Método de suscripción. |
|
Campos personalizados
|
Context.CustomFields | array of object | |
|
Id. de campo personalizado
|
Context.CustomFields.CustomFieldID | string |
Identificador de campo personalizado. |
|
Nombre
|
Context.CustomFields.Name | string |
Nombre. |
|
Importancia
|
Context.CustomFields.Value | string |
Valor. |
|
Se ha quitado activado
|
Context.RemovedOn | string |
Cuando se quita. |
Agregar varios suscriptores
Agrega varios suscriptores en una lista de distribución de correo con una sola llamada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de lista de distribución de correo
|
MailingListId | True | string |
Identificador de la lista de distribución de correo. |
|
Tiene doble participación externa
|
HasExternalDoubleOptIn | boolean |
Si tiene doble participación externa. |
|
|
Nombre
|
Name | string |
Nombre. |
|
|
Correo Electrónico
|
string |
Dirección de correo electrónico. |
||
|
Campos personalizados
|
CustomFields | array of string |
Campos personalizados. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
Context
|
Context | array of object | |
|
identificación
|
Context.ID | string |
Identificador. |
|
Nombre
|
Context.Name | string |
Nombre. |
|
Correo Electrónico
|
Context.Email | string |
Dirección de correo electrónico. |
|
Creadas el
|
Context.CreatedOn | string |
Cuando se crea. |
|
Actualizado al
|
Context.UpdatedOn | string |
Cuando se actualiza. |
|
Cancelación de suscripción
|
Context.UnsubscribedOn | string |
Cuando se cancela la suscripción. |
|
Cancelación de la suscripción del identificador
|
Context.UnsubscribedFromID | string |
El identificador que ha cancelado la suscripción. |
|
Tipo de suscripción
|
Context.SubscribeType | integer |
Tipo de suscripción. |
|
Método Subscribe
|
Context.SubscribeMethod | integer |
Método de suscripción. |
|
Campos personalizados
|
Context.CustomFields | array of object | |
|
Id. de campo personalizado
|
Context.CustomFields.CustomFieldID | string |
Identificador de campo personalizado. |
|
Nombre
|
Context.CustomFields.Name | string |
Nombre. |
|
Importancia
|
Context.CustomFields.Value | string |
Valor. |
|
Se ha quitado activado
|
Context.RemovedOn | string |
Se ha quitado. |
Anular la programación de una campaña
Quita una fecha y hora programadas definidas previamente de una campaña, de modo que se entregará inmediatamente si ya están en cola o cuando se envíen.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de campaña
|
CampaignId | True | string |
Identificador de la campaña. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
Context
|
Context | string |
Contexto. |
Cancelar la suscripción de suscriptor de la lista de distribución de correo
Cancela la suscripción de un suscriptor de la lista de distribución de correo especificada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de lista de distribución de correo
|
MailingListId | True | string |
Identificador de la lista de distribución de correo. |
|
Correo Electrónico
|
True | string |
Dirección de correo electrónico. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
Context
|
Context | string |
Contexto. |
Cancelar la suscripción del suscriptor de la cuenta
Cancela la suscripción de un suscriptor de la cuenta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Correo Electrónico
|
True | string |
Dirección de correo electrónico. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
Context
|
Context | string |
Contexto. |
Clonación de una campaña existente
Crea una copia exacta de una campaña existente. La nueva campaña se crea como borrador.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de campaña
|
CampaignId | True | string |
Identificador de la campaña. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
identificación
|
Context.ID | string |
Identificador. |
|
Nombre
|
Context.Name | string |
Nombre. |
|
Asunto
|
Context.Subject | string |
El asunto. |
|
Ubicación web
|
Context.WebLocation | string |
Ubicación web. |
|
Contenido HTML
|
Context.HTMLContent | string |
Contenido HTML. |
|
Contenido sin formato
|
Context.PlainContent | string |
Contenido sin formato. |
|
identificación
|
Context.Sender.ID | string |
Identificador. |
|
Nombre
|
Context.Sender.Name | string |
Nombre. |
|
Correo Electrónico
|
Context.Sender.Email | string |
Dirección de correo electrónico. |
|
Creadas el
|
Context.Sender.CreatedOn | string |
Cuando se crea. |
|
Está habilitado
|
Context.Sender.IsEnabled | boolean |
Indica si está habilitado. |
|
Comprobación de SPF
|
Context.Sender.SpfVerified | boolean |
Indica si se ha comprobado SPF. |
|
Comprobación de DKIM
|
Context.Sender.DkimVerified | boolean |
Indica si se ha comprobado DKIM. |
|
DKIM Public
|
Context.Sender.DkimPublic | string |
DKIM público. |
|
Entregado
|
Context.DeliveredOn | string |
Cuando se entrega. |
|
identificación
|
Context.ReplyToEmail.ID | string |
Identificador. |
|
Nombre
|
Context.ReplyToEmail.Name | string |
Nombre. |
|
Correo Electrónico
|
Context.ReplyToEmail.Email | string |
Dirección de correo electrónico. |
|
Creadas el
|
Context.ReplyToEmail.CreatedOn | string |
Cuando se crea. |
|
Está habilitado
|
Context.ReplyToEmail.IsEnabled | boolean |
Indica si está habilitado. |
|
Comprobación de SPF
|
Context.ReplyToEmail.SpfVerified | boolean |
Indica si se ha comprobado SPF. |
|
Comprobación de DKIM
|
Context.ReplyToEmail.DkimVerified | boolean |
Indica si se ha comprobado DKIM. |
|
DKIM Public
|
Context.ReplyToEmail.DkimPublic | string |
DKIM público. |
|
Creadas el
|
Context.CreatedOn | string |
Cuando se crea. |
|
Actualizado al
|
Context.UpdatedOn | string |
Cuando se actualiza. |
|
Programado para
|
Context.ScheduledFor | string |
Cuando está programado para. |
|
Timezone
|
Context.Timezone | string |
La zona horaria. |
|
Tipo de formato
|
Context.FormatType | integer |
Tipo de formato. |
|
identificación
|
Context.ABCampaignData.ID | integer |
Identificador. |
|
B Asunto
|
Context.ABCampaignData.SubjectB | string |
El asunto B. |
|
Contenido sin formato B
|
Context.ABCampaignData.PlainContentB | string |
Contenido sin formato B. |
|
Contenido HTML B
|
Context.ABCampaignData.HTMLContentB | string |
Contenido HTML B. |
|
Ubicación web B
|
Context.ABCampaignData.WebLocationB | string |
Ubicación web B. |
|
B Remitente
|
Context.ABCampaignData.SenderB | string |
Remitente B. |
|
Horas que se van a probar
|
Context.ABCampaignData.HoursToTest | integer |
Horas que se van a probar. |
|
Porcentaje de lista
|
Context.ABCampaignData.ListPercentage | integer |
Porcentaje de lista. |
|
Tipo de campaña AB
|
Context.ABCampaignData.ABCampaignType | integer |
Tipo de campaña AB. |
|
Tipo de selección ab winner
|
Context.ABCampaignData.ABWinnerSelectionType | integer |
Tipo de selección ab ganador. |
|
Un entregado
|
Context.ABCampaignData.DeliveredOnA | string |
La A se entrega. |
|
B Entregado
|
Context.ABCampaignData.DeliveredOnB | string |
El B se entregó. |
|
Listas de distribución de correo
|
Context.MailingLists | array of object | |
|
Id. de lista de distribución de correo
|
Context.MailingLists.MailingListID | string |
Identificador de la lista de distribución de correo. |
|
Id. de segmento
|
Context.MailingLists.SegmentID | integer |
Identificador del segmento. |
|
Confirmación a
|
Context.ConfirmationTo | string |
Confirmación a la que. |
|
Estado
|
Context.Status | integer |
Estado. |
|
Es transaccional
|
Context.IsTransactional | boolean |
Si es transaccional. |
Creación de un campo personalizado
Crea un nuevo campo personalizado en la lista de distribución de correo especificada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de lista de distribución de correo
|
MailingListId | True | string |
Identificador de la lista de distribución de correo. |
|
Nombre
|
Name | string |
Nombre. |
|
|
Tipo de campo personalizado
|
CustomFieldType | string |
Tipo de campo personalizado. |
|
|
Options
|
Options | string |
Las opciones. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
Context
|
Context | string |
Contexto. |
Crear una campaña de borrador
Crea una nueva campaña de borrador en su cuenta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre
|
Name | string |
Nombre. |
|
|
Asunto
|
Subject | string |
El asunto. |
|
|
Correo electrónico del remitente
|
SenderEmail | string |
Dirección de correo electrónico del remitente. |
|
|
Responder al correo electrónico
|
ReplyToEmail | string |
Respuesta a la dirección de correo electrónico. |
|
|
Confirmación al correo electrónico
|
ConfirmationToEmail | string |
Confirmación de la dirección de correo electrónico. |
|
|
Ubicación web
|
WebLocation | string |
Ubicación web. |
|
|
Id. de lista de distribución de correo
|
MailingListID | string |
Identificador de la lista de distribución de correo. |
|
|
Id. de segmento
|
SegmentID | string |
Identificador del segmento. |
|
|
Es AB
|
IsAB | string |
es AB. |
|
|
Tipo de campaña AB
|
ABCampaignType | string |
Tipo de campaña AB. |
|
|
Ubicación web B
|
WebLocationB | string |
Ubicación web B. |
|
|
Horas que se van a probar
|
HoursToTest | string |
Horas que se van a probar. |
|
|
Porcentaje de lista
|
ListPercentage | string |
Porcentaje de lista. |
|
|
Tipo de selección ab winner
|
ABWinnerSelectionType | string |
Tipo de selección ab ganador. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
Context
|
Context | string |
Contexto. |
Crear una lista de correo
Crea una nueva lista de correo vacía en su cuenta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre
|
Name | string |
Nombre. |
|
|
Página de confirmación
|
ConfirmationPage | string |
Página de confirmación. |
|
|
Redireccionamiento después de cancelar la suscripción a la página
|
RedirectAfterUnsubscribePage | string |
Redirección después de cancelar la suscripción. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
Context
|
Context | string |
Contexto. |
Eliminación de una campaña
Elimina una campaña de su cuenta, borrador o incluso enviada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de campaña
|
CampaignId | True | string |
Identificador de la campaña. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
Context
|
Context | string |
Contexto. |
Eliminación de varios suscriptores
Quita una lista de suscriptores de la lista de distribución de correo especificada de forma permanente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de lista de distribución de correo
|
MailingListId | True | string |
Identificador de la lista de distribución de correo. |
|
Correos electrónicos
|
Emails | True | string |
Los correos electrónicos. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
Correos electrónicos omitido
|
Context.EmailsIgnored | integer |
Los correos electrónicos se omiten. |
|
Correos electrónicos procesados
|
Context.EmailsProcessed | integer |
Los correos electrónicos procesados. |
Eliminar una lista de distribución de correo
Elimina una lista de correo de su cuenta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de lista de distribución de correo
|
MailingListId | True | string |
Identificador de la lista de distribución de correo. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
Context
|
Context | string |
Contexto. |
Enviar una campaña
Envía una campaña de borrador existente a todos los destinatarios especificados en su lista de correo. La campaña se envía inmediatamente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de campaña
|
CampaignId | True | string |
Identificador de la campaña. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
Context
|
Context | string |
Contexto. |
Obtención de los detalles del remitente
Devuelve información del remitente especificado identificado por su dirección de correo electrónico.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Correo Electrónico
|
True | string |
Dirección de correo electrónico. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
identificación
|
Context.ID | string |
Identificador. |
|
Nombre
|
Context.Name | string |
Nombre. |
|
Correo Electrónico
|
Context.Email | string |
Dirección de correo electrónico. |
|
Creadas el
|
Context.CreatedOn | string |
Cuando se crea. |
|
Está habilitado
|
Context.IsEnabled | boolean |
Indica si está habilitado. |
|
Comprobación de SPF
|
Context.SpfVerified | boolean |
Indica si se ha comprobado SPF. |
|
Comprobación de DKIM
|
Context.DkimVerified | boolean |
Indica si se ha comprobado DKIM. |
|
DKIM Public
|
Context.DkimPublic | string |
DKIM público. |
Obtención del resumen de la campaña de prueba ab
Proporciona un resumen básico de los resultados de una campaña de prueba ab enviada, por separado para cada versión (A y B), como el número de destinatarios, se abre, hace clic, rebota, cancela la suscripción, reenvía, etc.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de campaña
|
CampaignId | True | string |
Identificador de la campaña. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
Identificador de campaña
|
Context.CampaignID | string |
Identificador de la campaña. |
|
Identificador de campaña
|
Context.A.CampaignID | string |
Identificador de la campaña. |
|
Versión ab
|
Context.A.ABVersion | integer |
Versión AB. |
|
Nombre de la campaña
|
Context.A.CampaignName | string |
Nombre de la campaña. |
|
Asunto de la campaña
|
Context.A.CampaignSubject | string |
El asunto de la campaña. |
|
Listas de distribución de correo
|
Context.A.MailingLists | array of object | |
|
Campaña
|
Context.A.MailingLists.Campaign | string |
La campaña. |
|
identificación
|
Context.A.MailingLists.MailingList.ID | string |
Identificador. |
|
Nombre
|
Context.A.MailingLists.MailingList.Name | string |
Nombre. |
|
Recuento de miembros activos
|
Context.A.MailingLists.MailingList.ActiveMemberCount | integer |
Recuento de miembros activos. |
|
Recuento de miembros devueltos
|
Context.A.MailingLists.MailingList.BouncedMemberCount | integer |
Recuento de miembros devueltos. |
|
Recuento de miembros quitado
|
Context.A.MailingLists.MailingList.RemovedMemberCount | integer |
Recuento de miembros quitado. |
|
Recuento de miembros cancelados
|
Context.A.MailingLists.MailingList.UnsubscribedMemberCount | integer |
Recuento de miembros cancelados. |
|
Estado
|
Context.A.MailingLists.MailingList.Status | integer |
Estado. |
|
Definición de campos personalizados
|
Context.A.MailingLists.MailingList.CustomFieldsDefinition | array of |
Definición de campos personalizados. |
|
Autor
|
Context.A.MailingLists.MailingList.CreatedBy | string |
Objeto creado por. |
|
Creadas el
|
Context.A.MailingLists.MailingList.CreatedOn | string |
Cuando se crea. |
|
Actualizado por
|
Context.A.MailingLists.MailingList.UpdatedBy | string |
Actualizado por. |
|
Actualizado al
|
Context.A.MailingLists.MailingList.UpdatedOn | string |
Actualizado. |
|
Operación de importación
|
Context.A.MailingLists.MailingList.ImportOperation | string |
Operación de importación. |
|
Segmento
|
Context.A.MailingLists.Segment | string |
Segmento. |
|
Campaña entregada
|
Context.A.CampaignDeliveredOn | string |
La campaña se entrega. |
|
Para
|
Context.A.To | string |
La dirección Para. |
|
De
|
Context.A.From | string |
Dirección From. |
|
Total de aperturas
|
Context.A.TotalOpens | integer |
Se abre el total. |
|
Aperturas únicas
|
Context.A.UniqueOpens | integer |
Se abre el valor único. |
|
Total de rebotes
|
Context.A.TotalBounces | integer |
El total de rebotes. |
|
Total de quejas
|
Context.A.TotalComplaints | integer |
El total de quejas. |
|
Total de reenvíos
|
Context.A.TotalForwards | integer |
El total de reenvíos. |
|
Reenvíos únicos
|
Context.A.UniqueForwards | integer |
Los reenvíos únicos. |
|
Total de cancelaciones de suscripción
|
Context.A.TotalUnsubscribes | integer |
El total de cancelaciones de suscripción. |
|
Total de clics de vínculo
|
Context.A.TotalLinkClicks | integer |
El vínculo total hace clic. |
|
Clics de vínculo únicos
|
Context.A.UniqueLinkClicks | integer |
El vínculo único hace clic. |
|
Sent
|
Context.A.Sent | integer |
Número enviado. |
|
La campaña está archivada
|
Context.A.CampaignIsArchived | boolean |
Si la campaña está archivada. |
|
Identificador de campaña
|
Context.B.CampaignID | string |
Identificador de la campaña. |
|
Versión ab
|
Context.B.ABVersion | integer |
Versión AB. |
|
Nombre de la campaña
|
Context.B.CampaignName | string |
Nombre de la campaña. |
|
Asunto de la campaña
|
Context.B.CampaignSubject | string |
El asunto de la campaña. |
|
Listas de distribución de correo
|
Context.B.MailingLists | array of object | |
|
Campaña
|
Context.B.MailingLists.Campaign | string |
La campaña. |
|
identificación
|
Context.B.MailingLists.MailingList.ID | string |
Identificador. |
|
Nombre
|
Context.B.MailingLists.MailingList.Name | string |
Nombre. |
|
Recuento de miembros activos
|
Context.B.MailingLists.MailingList.ActiveMemberCount | integer |
Recuento de miembros activos. |
|
Recuento de miembros devueltos
|
Context.B.MailingLists.MailingList.BouncedMemberCount | integer |
Recuento de miembros devueltos. |
|
Recuento de miembros quitado
|
Context.B.MailingLists.MailingList.RemovedMemberCount | integer |
Recuento de miembros quitado. |
|
Recuento de miembros cancelados
|
Context.B.MailingLists.MailingList.UnsubscribedMemberCount | integer |
Recuento de miembros cancelados. |
|
Estado
|
Context.B.MailingLists.MailingList.Status | integer |
Estado. |
|
Definición de campos personalizados
|
Context.B.MailingLists.MailingList.CustomFieldsDefinition | array of |
Definición de campos personalizados. |
|
Autor
|
Context.B.MailingLists.MailingList.CreatedBy | string |
Objeto creado por. |
|
Creadas el
|
Context.B.MailingLists.MailingList.CreatedOn | string |
Cuando se crea. |
|
Actualizado por
|
Context.B.MailingLists.MailingList.UpdatedBy | string |
Actualizado por. |
|
Actualizado al
|
Context.B.MailingLists.MailingList.UpdatedOn | string |
Actualizado. |
|
Operación de importación
|
Context.B.MailingLists.MailingList.ImportOperation | string |
Operación de importación. |
|
Segmento
|
Context.B.MailingLists.Segment | string |
Segmento. |
|
Campaña entregada
|
Context.B.CampaignDeliveredOn | string |
La campaña se entrega. |
|
Para
|
Context.B.To | string |
La dirección Para. |
|
De
|
Context.B.From | string |
Dirección From. |
|
Total de aperturas
|
Context.B.TotalOpens | integer |
Se abre el total. |
|
Aperturas únicas
|
Context.B.UniqueOpens | integer |
Se abre el valor único. |
|
Total de rebotes
|
Context.B.TotalBounces | integer |
El total de rebotes. |
|
Total de quejas
|
Context.B.TotalComplaints | integer |
El total de quejas. |
|
Total de reenvíos
|
Context.B.TotalForwards | integer |
El total de reenvíos. |
|
Reenvíos únicos
|
Context.B.UniqueForwards | integer |
Los reenvíos únicos. |
|
Total de cancelaciones de suscripción
|
Context.B.TotalUnsubscribes | integer |
El total de cancelaciones de suscripción. |
|
Total de clics de vínculo
|
Context.B.TotalLinkClicks | integer |
El vínculo total hace clic. |
|
Clics de vínculo únicos
|
Context.B.UniqueLinkClicks | integer |
El vínculo único hace clic. |
|
Sent
|
Context.B.Sent | integer |
Número enviado. |
|
La campaña está archivada
|
Context.B.CampaignIsArchived | boolean |
Si la campaña está archivada. |
Obtener actividad de vínculo
Devuelve una lista con los vínculos de campaña y cuántos clics han realizado los destinatarios, ya sea únicos o totales.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de campaña
|
CampaignId | True | string |
Identificador de la campaña. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
Tamaño de página
|
Context.Paging.PageSize | integer |
Tamaño de página. |
|
Página actual
|
Context.Paging.CurrentPage | integer |
Página actual. |
|
Total de resultados
|
Context.Paging.TotalResults | integer |
Resultados totales. |
|
Recuento total de páginas
|
Context.Paging.TotalPageCount | integer |
Recuento total de páginas. |
|
Expresión de ordenación
|
Context.Paging.SortExpression | string |
Expresión de ordenación. |
|
La ordenación es ascendente
|
Context.Paging.SortIsAscending | boolean |
Si la ordenación es ascendente. |
|
Análisis de datos
|
Context.Analytics | array of object | |
|
Context
|
Context.Analytics.Context | string |
Contexto. |
|
Nombre del contexto
|
Context.Analytics.ContextName | string |
Nombre de contexto. |
|
Recuento total
|
Context.Analytics.TotalCount | integer |
Recuento total. |
|
Recuento único
|
Context.Analytics.UniqueCount | integer |
Recuento único. |
|
Descripción del contexto
|
Context.Analytics.ContextDescription | string |
Descripción del contexto. |
Obtener actividad por ubicación
Devuelve un informe detallado de la campaña que abre (único y total) por país.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de campaña
|
CampaignId | True | string |
Identificador de la campaña. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
Tamaño de página
|
Context.Paging.PageSize | integer |
Tamaño de página. |
|
Página actual
|
Context.Paging.CurrentPage | integer |
Página actual. |
|
Total de resultados
|
Context.Paging.TotalResults | integer |
Resultados totales. |
|
Recuento total de páginas
|
Context.Paging.TotalPageCount | integer |
Recuento total de páginas. |
|
Expresión de ordenación
|
Context.Paging.SortExpression | string |
Expresión de ordenación. |
|
La ordenación es ascendente
|
Context.Paging.SortIsAscending | boolean |
Si la ordenación es ascendente. |
|
Análisis de datos
|
Context.Analytics | array of object | |
|
Context
|
Context.Analytics.Context | string |
Contexto. |
|
Nombre del contexto
|
Context.Analytics.ContextName | string |
Nombre de contexto. |
|
Recuento total
|
Context.Analytics.TotalCount | integer |
Recuento total. |
|
Recuento único
|
Context.Analytics.UniqueCount | integer |
Recuento único. |
|
Descripción del contexto
|
Context.Analytics.ContextDescription | string |
Descripción del contexto. |
Obtener campañas
Devuelve una lista de todas las campañas de tu cuenta con información detallada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Página
|
Page | True | string |
La página. |
|
Tamaño de página
|
PageSize | True | string |
Tamaño de página. |
|
Ordenar por
|
SortBy | string |
La ordenación por. |
|
|
Sort (método)
|
SortMethod | string |
Método de ordenación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
Tamaño de página
|
Context.Paging.PageSize | integer |
Tamaño de página. |
|
Página actual
|
Context.Paging.CurrentPage | integer |
Página actual. |
|
Total de resultados
|
Context.Paging.TotalResults | integer |
Resultados totales. |
|
Recuento total de páginas
|
Context.Paging.TotalPageCount | integer |
Recuento total de páginas. |
|
Expresión de ordenación
|
Context.Paging.SortExpression | string |
Expresión de ordenación. |
|
La ordenación es ascendente
|
Context.Paging.SortIsAscending | boolean |
Si la ordenación es ascendente. |
|
Campañas
|
Context.Campaigns | array of object | |
|
identificación
|
Context.Campaigns.ID | string |
Identificador. |
|
Nombre
|
Context.Campaigns.Name | string |
Nombre. |
|
Asunto
|
Context.Campaigns.Subject | string |
El asunto. |
|
Nombre del sitio
|
Context.Campaigns.SiteName | string |
Nombre del sitio. |
|
Confirmación a
|
Context.Campaigns.ConfirmationTo | string |
Confirmación a la que. |
|
Creadas el
|
Context.Campaigns.CreatedOn | string |
Cuando se crea. |
|
AB Hours To Test
|
Context.Campaigns.ABHoursToTest | string |
Horas ab que se van a probar. |
|
Tipo de campaña AB
|
Context.Campaigns.ABCampaignType | string |
Tipo de campaña AB. |
|
Ganador A/ B
|
Context.Campaigns.ABWinner | string |
El ganador de AB. |
|
Tipo de selección ab winner
|
Context.Campaigns.ABWinnerSelectionType | string |
Tipo de selección ab ganador. |
|
Estado
|
Context.Campaigns.Status | integer |
Estado. |
|
Entregado
|
Context.Campaigns.DeliveredOn | string |
Cuando se entrega. |
|
Programado para
|
Context.Campaigns.ScheduledFor | string |
Cuando está programado para. |
|
Programado para la zona horaria
|
Context.Campaigns.ScheduledForTimezone | string |
Programado para la zona horaria. |
|
Listas de distribución de correo
|
Context.Campaigns.MailingLists | array of object | |
|
Campaña
|
Context.Campaigns.MailingLists.Campaign | string |
La campaña. |
|
identificación
|
Context.Campaigns.MailingLists.MailingList.ID | string |
Identificador. |
|
Nombre
|
Context.Campaigns.MailingLists.MailingList.Name | string |
Nombre. |
|
Recuento de miembros activos
|
Context.Campaigns.MailingLists.MailingList.ActiveMemberCount | integer |
Recuento de miembros activos. |
|
Recuento de miembros devueltos
|
Context.Campaigns.MailingLists.MailingList.BouncedMemberCount | integer |
Recuento de miembros devueltos. |
|
Recuento de miembros quitado
|
Context.Campaigns.MailingLists.MailingList.RemovedMemberCount | integer |
Recuento de miembros quitado. |
|
Recuento de miembros cancelados
|
Context.Campaigns.MailingLists.MailingList.UnsubscribedMemberCount | integer |
Recuento de miembros cancelados. |
|
Estado
|
Context.Campaigns.MailingLists.MailingList.Status | integer |
Estado. |
|
Definición de campos personalizados
|
Context.Campaigns.MailingLists.MailingList.CustomFieldsDefinition | array of |
Definición de campos personalizados. |
|
Autor
|
Context.Campaigns.MailingLists.MailingList.CreatedBy | string |
Objeto creado por. |
|
Creadas el
|
Context.Campaigns.MailingLists.MailingList.CreatedOn | string |
Cuando se crea. |
|
Actualizado por
|
Context.Campaigns.MailingLists.MailingList.UpdatedBy | string |
Actualizado por. |
|
Actualizado al
|
Context.Campaigns.MailingLists.MailingList.UpdatedOn | string |
Cuando se actualiza. |
|
Operación de importación
|
Context.Campaigns.MailingLists.MailingList.ImportOperation | string |
Operación de importación. |
|
Segmento
|
Context.Campaigns.MailingLists.Segment | string |
Segmento. |
|
Total enviado
|
Context.Campaigns.TotalSent | integer |
Total enviado. |
|
Total de aperturas
|
Context.Campaigns.TotalOpens | integer |
Se abre el total. |
|
Aperturas únicas
|
Context.Campaigns.UniqueOpens | integer |
Se abre el valor único. |
|
Total de rebotes
|
Context.Campaigns.TotalBounces | integer |
El total de rebotes. |
|
Total de reenvíos
|
Context.Campaigns.TotalForwards | integer |
El total de reenvíos. |
|
Reenvíos únicos
|
Context.Campaigns.UniqueForwards | integer |
Los reenvíos únicos. |
|
Total de clics de vínculo
|
Context.Campaigns.TotalLinkClicks | integer |
El vínculo total hace clic. |
|
Clics de vínculo únicos
|
Context.Campaigns.UniqueLinkClicks | integer |
El vínculo único hace clic. |
|
Recuento de destinatarios
|
Context.Campaigns.RecipientsCount | integer |
Recuento de destinatarios. |
|
Es transaccional
|
Context.Campaigns.IsTransactional | boolean |
Si es transaccional. |
|
Total de quejas
|
Context.Campaigns.TotalComplaints | integer |
El total de quejas. |
|
Total de cancelaciones de suscripción
|
Context.Campaigns.TotalUnsubscribes | integer |
El total de cancelaciones de suscripción. |
Obtener detalles de la campaña
Devuelve un conjunto completo de propiedades que describen la campaña solicitada en detalle.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de campaña
|
CampaignId | True | string |
Identificador de la campaña. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
identificación
|
Context.ID | string |
Identificador. |
|
Nombre
|
Context.Name | string |
Nombre. |
|
Asunto
|
Context.Subject | string |
El asunto. |
|
Ubicación web
|
Context.WebLocation | string |
Ubicación web. |
|
Contenido HTML
|
Context.HTMLContent | string |
Contenido HTML. |
|
Contenido sin formato
|
Context.PlainContent | string |
Contenido sin formato. |
|
identificación
|
Context.Sender.ID | string |
Identificador. |
|
Nombre
|
Context.Sender.Name | string |
Nombre. |
|
Correo Electrónico
|
Context.Sender.Email | string |
Dirección de correo electrónico. |
|
Creadas el
|
Context.Sender.CreatedOn | string |
Cuando se crea. |
|
Está habilitado
|
Context.Sender.IsEnabled | boolean |
Indica si está habilitado. |
|
Comprobación de SPF
|
Context.Sender.SpfVerified | boolean |
Indica si se ha comprobado SPF. |
|
Comprobación de DKIM
|
Context.Sender.DkimVerified | boolean |
Indica si se ha comprobado DKIM. |
|
DKIM Public
|
Context.Sender.DkimPublic | string |
DKIM público. |
|
Entregado
|
Context.DeliveredOn | string |
Cuando se entrega. |
|
identificación
|
Context.ReplyToEmail.ID | string |
Identificador. |
|
Nombre
|
Context.ReplyToEmail.Name | string |
Nombre. |
|
Correo Electrónico
|
Context.ReplyToEmail.Email | string |
Dirección de correo electrónico. |
|
Creadas el
|
Context.ReplyToEmail.CreatedOn | string |
Cuando se crea. |
|
Está habilitado
|
Context.ReplyToEmail.IsEnabled | boolean |
Indica si está habilitado. |
|
Comprobación de SPF
|
Context.ReplyToEmail.SpfVerified | boolean |
Indica si se ha comprobado SPF. |
|
Comprobación de DKIM
|
Context.ReplyToEmail.DkimVerified | boolean |
Indica si se ha comprobado DKIM. |
|
DKIM Public
|
Context.ReplyToEmail.DkimPublic | string |
DKIM público. |
|
Creadas el
|
Context.CreatedOn | string |
Cuando se crea. |
|
Actualizado al
|
Context.UpdatedOn | string |
Cuando se actualiza. |
|
Programado para
|
Context.ScheduledFor | string |
Cuando está programado para. |
|
Timezone
|
Context.Timezone | string |
La zona horaria. |
|
Tipo de formato
|
Context.FormatType | integer |
Tipo de formato. |
|
Datos de campaña ab
|
Context.ABCampaignData | string |
Los datos de la campaña ab. |
|
Listas de distribución de correo
|
Context.MailingLists | array of object | |
|
Id. de lista de distribución de correo
|
Context.MailingLists.MailingListID | string |
Identificador de la lista de distribución de correo. |
|
Id. de segmento
|
Context.MailingLists.SegmentID | integer |
Identificador del segmento. |
|
Confirmación a
|
Context.ConfirmationTo | string |
Confirmación a la que. |
|
Estado
|
Context.Status | integer |
Estado. |
|
Es transaccional
|
Context.IsTransactional | boolean |
Si es transaccional. |
Obtener detalles de la lista de distribución de correo
Recupera los detalles de una lista de distribución de correo determinada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de lista de distribución de correo
|
MailingListId | True | string |
Identificador de la lista de distribución de correo. |
|
Con estadísticas
|
WithStatistics | boolean |
Si se trata de estadísticas. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
identificación
|
Context.ID | string |
Identificador. |
|
Nombre
|
Context.Name | string |
Nombre. |
|
Recuento de miembros activos
|
Context.ActiveMemberCount | integer |
Recuento de miembros activos. |
|
Recuento de miembros devueltos
|
Context.BouncedMemberCount | integer |
Recuento de miembros devueltos. |
|
Recuento de miembros quitado
|
Context.RemovedMemberCount | integer |
Recuento de miembros quitado. |
|
Recuento de miembros cancelados
|
Context.UnsubscribedMemberCount | integer |
Recuento de miembros cancelados. |
|
Estado
|
Context.Status | integer |
Estado. |
|
Definición de campos personalizados
|
Context.CustomFieldsDefinition | array of object | |
|
identificación
|
Context.CustomFieldsDefinition.ID | string |
Identificador. |
|
Nombre
|
Context.CustomFieldsDefinition.Name | string |
Nombre. |
|
Context
|
Context.CustomFieldsDefinition.Context | string |
Contexto. |
|
Se requiere
|
Context.CustomFieldsDefinition.IsRequired | boolean |
Indica si es necesario. |
|
Tipo
|
Context.CustomFieldsDefinition.Type | integer |
Tipo. |
|
Autor
|
Context.CreatedBy | string |
Objeto creado por. |
|
Creadas el
|
Context.CreatedOn | string |
Cuando se crea. |
|
Actualizado por
|
Context.UpdatedBy | string |
Actualizado por. |
|
Actualizado al
|
Context.UpdatedOn | string |
Cuando se actualiza. |
|
identificación
|
Context.ImportOperation.ID | integer |
Identificador. |
|
Hash de datos
|
Context.ImportOperation.DataHash | string |
Hash de datos. |
|
Mapeos
|
Context.ImportOperation.Mappings | string |
Asignaciones. |
|
Notificación por correo electrónico
|
Context.ImportOperation.EmailNotify | string |
El correo electrónico notifica. |
|
Creadas el
|
Context.ImportOperation.CreatedOn | string |
Cuando se crea. |
|
Iniciado el
|
Context.ImportOperation.StartedOn | string |
Cuando se inicia. |
|
Completado en
|
Context.ImportOperation.CompletedOn | string |
Cuando haya terminado. |
|
Total insertado
|
Context.ImportOperation.TotalInserted | integer |
Total insertado. |
|
Total actualizado
|
Context.ImportOperation.TotalUpdated | integer |
Total actualizado. |
|
Total de cancelaciones de suscripción
|
Context.ImportOperation.TotalUnsubscribed | integer |
Total cancelado. |
|
Total no válido
|
Context.ImportOperation.TotalInvalid | integer |
Total no válido. |
|
Total omitido
|
Context.ImportOperation.TotalIgnored | integer |
Total omitido. |
|
Total de duplicados
|
Context.ImportOperation.TotalDuplicate | integer |
El duplicado total. |
|
Total de miembros
|
Context.ImportOperation.TotalMembers | integer |
El total de miembros. |
|
Message
|
Context.ImportOperation.Message | string |
Mensaje. |
|
Success
|
Context.ImportOperation.Success | boolean |
Si se realiza correctamente. |
|
Omitir nuevos miembros
|
Context.ImportOperation.SkipNewMembers | boolean |
Si se omiten los nuevos miembros. |
Obtener estadísticas de campaña
Recupera una lista detallada de estadísticas de una campaña determinada basada en actividades como correos electrónicos enviados, abiertos, devueltos, clics de vínculo, etc.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de campaña
|
CampaignId | True | string |
Identificador de la campaña. |
|
Tipo
|
Type | True | string |
Tipo. |
|
Página
|
Page | integer |
La página. |
|
|
Tamaño de página
|
PageSize | integer |
Tamaño de página. |
|
|
De
|
From | string |
Dirección From. |
|
|
Para
|
To | string |
La dirección Para. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
Tamaño de página
|
Context.Paging.PageSize | integer |
Tamaño de página. |
|
Página actual
|
Context.Paging.CurrentPage | integer |
Página actual. |
|
Total de resultados
|
Context.Paging.TotalResults | integer |
Resultados totales. |
|
Recuento total de páginas
|
Context.Paging.TotalPageCount | integer |
Recuento total de páginas. |
|
Expresión de ordenación
|
Context.Paging.SortExpression | string |
Expresión de ordenación. |
|
La ordenación es ascendente
|
Context.Paging.SortIsAscending | boolean |
Si la ordenación es ascendente. |
|
Análisis de datos
|
Context.Analytics | array of object | |
|
Context
|
Context.Analytics.Context | string |
Contexto. |
|
Nombre del contexto
|
Context.Analytics.ContextName | string |
Nombre de contexto. |
|
Recuento total
|
Context.Analytics.TotalCount | integer |
Recuento total. |
|
Recuento único
|
Context.Analytics.UniqueCount | integer |
Recuento único. |
|
Descripción del contexto
|
Context.Analytics.ContextDescription | string |
Descripción del contexto. |
Obtener remitentes
Recupera una lista de los remitentes activos de su cuenta.
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
Context
|
Context | array of object | |
|
identificación
|
Context.ID | string |
Identificador. |
|
Nombre
|
Context.Name | string |
Nombre. |
|
Correo Electrónico
|
Context.Email | string |
Dirección de correo electrónico. |
|
Creadas el
|
Context.CreatedOn | string |
Cuando se crea. |
|
Está habilitado
|
Context.IsEnabled | boolean |
Indica si está habilitado. |
|
Comprobación de SPF
|
Context.SpfVerified | boolean |
Indica si se ha comprobado SPF. |
|
Comprobación de DKIM
|
Context.DkimVerified | boolean |
Indica si se ha comprobado DKIM. |
|
DKIM Public
|
Context.DkimPublic | string |
DKIM público. |
Obtener resumen de campaña
Recupera un resumen básico de los resultados de cualquier campaña enviada, como el número de destinatarios, se abre, hace clic, rebota, cancela la suscripción, reenvía, etc. hasta la fecha.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de campaña
|
CampaignId | True | string |
Identificador de la campaña. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
Identificador de campaña
|
Context.CampaignID | string |
Identificador de la campaña. |
|
Versión ab
|
Context.ABVersion | string |
Versión AB. |
|
Nombre de la campaña
|
Context.CampaignName | string |
Nombre de la campaña. |
|
Asunto de la campaña
|
Context.CampaignSubject | string |
El asunto de la campaña. |
|
Listas de distribución de correo
|
Context.MailingLists | array of object | |
|
Id. de lista de distribución de correo
|
Context.MailingLists.MailingListID | string |
Identificador de la lista de distribución de correo. |
|
Id. de segmento
|
Context.MailingLists.SegmentID | integer |
Identificador del segmento. |
|
Campaña entregada
|
Context.CampaignDeliveredOn | string |
Cuando se entrega la campaña. |
|
Para
|
Context.To | string |
La dirección Para. |
|
De
|
Context.From | string |
Dirección From. |
|
Total de aperturas
|
Context.TotalOpens | integer |
Se abre el total. |
|
Aperturas únicas
|
Context.UniqueOpens | integer |
Se abre el valor único. |
|
Total de rebotes
|
Context.TotalBounces | integer |
El total de rebotes. |
|
Total de quejas
|
Context.TotalComplaints | integer |
El total de quejas. |
|
Total de reenvíos
|
Context.TotalForwards | integer |
El total de reenvíos. |
|
Reenvíos únicos
|
Context.UniqueForwards | integer |
Los reenvíos únicos. |
|
Total de cancelaciones de suscripción
|
Context.TotalUnsubscribes | integer |
El total de cancelaciones de suscripción. |
|
Total de clics de vínculo
|
Context.TotalLinkClicks | integer |
El vínculo total hace clic. |
|
Clics de vínculo únicos
|
Context.UniqueLinkClicks | integer |
El vínculo único hace clic. |
|
Sent
|
Context.Sent | integer |
Número enviado. |
|
La campaña está archivada
|
Context.CampaignIsArchived | boolean |
Si la campaña está archivada. |
Obtener suscriptor por dirección de correo electrónico
Busca un suscriptor con la dirección de correo electrónico especificada en la lista de correo especificada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de lista de distribución de correo
|
MailingListId | True | string |
Identificador de la lista de distribución de correo. |
|
Correo Electrónico
|
True | string |
Dirección de correo electrónico. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
identificación
|
Context.ID | string |
Identificador. |
|
Nombre
|
Context.Name | string |
Nombre. |
|
Correo Electrónico
|
Context.Email | string |
Dirección de correo electrónico. |
|
Creadas el
|
Context.CreatedOn | string |
Cuando se crea. |
|
Actualizado al
|
Context.UpdatedOn | string |
Cuando se actualiza. |
|
Cancelación de suscripción
|
Context.UnsubscribedOn | string |
Cuando se cancela la suscripción. |
|
Cancelación de la suscripción del identificador
|
Context.UnsubscribedFromID | string |
El identificador que ha cancelado la suscripción. |
|
Tipo de suscripción
|
Context.SubscribeType | integer |
Tipo de suscripción. |
|
Método Subscribe
|
Context.SubscribeMethod | integer |
Método de suscripción. |
|
Campos personalizados
|
Context.CustomFields | array of object | |
|
Id. de campo personalizado
|
Context.CustomFields.CustomFieldID | string |
Identificador de campo personalizado. |
|
Nombre
|
Context.CustomFields.Name | string |
Nombre. |
|
Importancia
|
Context.CustomFields.Value | string |
Valor. |
|
Se ha quitado activado
|
Context.RemovedOn | string |
Cuando se quita. |
Obtener suscriptor por identificador
Busca un suscriptor con el identificador único especificado en la lista de distribución de correo especificada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de lista de distribución de correo
|
MailingListId | True | string |
Identificador de la lista de distribución de correo. |
|
Identificador de suscriptor
|
SubscriberId | True | string |
Identificador del suscriptor. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
identificación
|
Context.ID | string |
Identificador. |
|
Nombre
|
Context.Name | string |
Nombre. |
|
Correo Electrónico
|
Context.Email | string |
Dirección de correo electrónico. |
|
Creadas el
|
Context.CreatedOn | string |
Cuando se crea. |
|
Actualizado al
|
Context.UpdatedOn | string |
Cuando se actualiza. |
|
Cancelación de suscripción
|
Context.UnsubscribedOn | string |
Cuando se cancela la suscripción. |
|
Cancelación de la suscripción del identificador
|
Context.UnsubscribedFromID | string |
El identificador que ha cancelado la suscripción. |
|
Tipo de suscripción
|
Context.SubscribeType | integer |
Tipo de suscripción. |
|
Método Subscribe
|
Context.SubscribeMethod | integer |
Método de suscripción. |
|
Campos personalizados
|
Context.CustomFields | array of |
Campos personalizados. |
|
Se ha quitado activado
|
Context.RemovedOn | string |
Cuando se quita. |
Obtener suscriptores
Recupera una lista de todos los suscriptores de una lista de correo determinada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de lista de distribución de correo
|
MailingListId | True | string |
Identificador de la lista de distribución de correo. |
|
Página
|
Page | integer |
La página. |
|
|
Tamaño de página
|
PageSize | integer |
Tamaño de página. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
Tamaño de página
|
Context.Paging.PageSize | integer |
Tamaño de página. |
|
Página actual
|
Context.Paging.CurrentPage | integer |
Página actual. |
|
Total de resultados
|
Context.Paging.TotalResults | integer |
Resultados totales. |
|
Recuento total de páginas
|
Context.Paging.TotalPageCount | integer |
Recuento total de páginas. |
|
Expresión de ordenación
|
Context.Paging.SortExpression | string |
Expresión de ordenación. |
|
La ordenación es ascendente
|
Context.Paging.SortIsAscending | boolean |
Si la ordenación es ascendente. |
|
Subscribers
|
Context.Subscribers | array of object | |
|
identificación
|
Context.Subscribers.ID | string |
Identificador. |
|
Nombre
|
Context.Subscribers.Name | string |
Nombre. |
|
Correo Electrónico
|
Context.Subscribers.Email | string |
Dirección de correo electrónico. |
|
Creadas el
|
Context.Subscribers.CreatedOn | string |
Cuando se crea. |
|
Actualizado al
|
Context.Subscribers.UpdatedOn | string |
Actualizado. |
|
Cancelación de suscripción
|
Context.Subscribers.UnsubscribedOn | string |
Cuando se cancela la suscripción. |
|
Cancelación de la suscripción del identificador
|
Context.Subscribers.UnsubscribedFromID | string |
El identificador que ha cancelado la suscripción. |
|
Tipo de suscripción
|
Context.Subscribers.SubscribeType | integer |
Tipo de suscripción. |
|
Método Subscribe
|
Context.Subscribers.SubscribeMethod | integer |
Método de suscripción. |
|
Campos personalizados
|
Context.Subscribers.CustomFields | array of object | |
|
Id. de campo personalizado
|
Context.Subscribers.CustomFields.CustomFieldID | string |
Identificador de campo personalizado. |
|
Nombre
|
Context.Subscribers.CustomFields.Name | string |
Nombre. |
|
Importancia
|
Context.Subscribers.CustomFields.Value | string |
Valor. |
|
Se ha quitado activado
|
Context.Subscribers.RemovedOn | string |
Cuando se quita. |
Obtener todas las listas de distribución de correo activas
Recupera una lista de las listas de correo activas en su cuenta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Página
|
Page | True | integer |
La página. |
|
Tamaño de página
|
PageSize | True | integer |
Tamaño de página. |
|
Ordenar por
|
SortBy | string |
La ordenación por. |
|
|
Sort (método)
|
SortMethod | string |
Método de ordenación. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
Tamaño de página
|
Context.Paging.PageSize | integer |
Tamaño de página. |
|
Página actual
|
Context.Paging.CurrentPage | integer |
Página actual. |
|
Total de resultados
|
Context.Paging.TotalResults | integer |
Resultados totales. |
|
Recuento total de páginas
|
Context.Paging.TotalPageCount | integer |
Recuento total de páginas. |
|
Expresión de ordenación
|
Context.Paging.SortExpression | string |
Expresión de ordenación. |
|
La ordenación es ascendente
|
Context.Paging.SortIsAscending | boolean |
Si la ordenación es ascendente. |
|
Listas de distribución de correo
|
Context.MailingLists | array of object | |
|
identificación
|
Context.MailingLists.ID | string |
Identificador. |
|
Nombre
|
Context.MailingLists.Name | string |
Nombre. |
|
Recuento de miembros activos
|
Context.MailingLists.ActiveMemberCount | integer |
Recuento de miembros activos. |
|
Recuento de miembros devueltos
|
Context.MailingLists.BouncedMemberCount | integer |
Recuento de miembros devueltos. |
|
Recuento de miembros quitado
|
Context.MailingLists.RemovedMemberCount | integer |
Recuento de miembros quitado. |
|
Recuento de miembros cancelados
|
Context.MailingLists.UnsubscribedMemberCount | integer |
Recuento de miembros cancelados. |
|
Estado
|
Context.MailingLists.Status | integer |
Estado. |
|
Definición de campos personalizados
|
Context.MailingLists.CustomFieldsDefinition | array of object | |
|
identificación
|
Context.MailingLists.CustomFieldsDefinition.ID | string |
Identificador. |
|
Nombre
|
Context.MailingLists.CustomFieldsDefinition.Name | string |
Nombre. |
|
Context
|
Context.MailingLists.CustomFieldsDefinition.Context | string |
Contexto. |
|
Se requiere
|
Context.MailingLists.CustomFieldsDefinition.IsRequired | boolean |
Indica si es necesario. |
|
Tipo
|
Context.MailingLists.CustomFieldsDefinition.Type | integer |
Tipo. |
|
Autor
|
Context.MailingLists.CreatedBy | string |
Objeto creado por. |
|
Creadas el
|
Context.MailingLists.CreatedOn | string |
Cuando se crea. |
|
Actualizado por
|
Context.MailingLists.UpdatedBy | string |
Actualizado por. |
|
Actualizado al
|
Context.MailingLists.UpdatedOn | string |
Actualizado. |
|
identificación
|
Context.MailingLists.ImportOperation.ID | integer |
Identificador. |
|
Hash de datos
|
Context.MailingLists.ImportOperation.DataHash | string |
Hash de datos. |
|
Mapeos
|
Context.MailingLists.ImportOperation.Mappings | string |
Asignaciones. |
|
Notificación por correo electrónico
|
Context.MailingLists.ImportOperation.EmailNotify | string |
El correo electrónico de notificación. |
|
Creadas el
|
Context.MailingLists.ImportOperation.CreatedOn | string |
Cuando se crea. |
|
Iniciado el
|
Context.MailingLists.ImportOperation.StartedOn | string |
Cuando se inicia. |
|
Completado en
|
Context.MailingLists.ImportOperation.CompletedOn | string |
Cuando haya terminado. |
|
Total insertado
|
Context.MailingLists.ImportOperation.TotalInserted | integer |
Total insertado. |
|
Total actualizado
|
Context.MailingLists.ImportOperation.TotalUpdated | integer |
Total actualizado. |
|
Total de cancelaciones de suscripción
|
Context.MailingLists.ImportOperation.TotalUnsubscribed | integer |
Total cancelado. |
|
Total no válido
|
Context.MailingLists.ImportOperation.TotalInvalid | integer |
Total no válido. |
|
Total de duplicados
|
Context.MailingLists.ImportOperation.TotalDuplicate | integer |
El duplicado total. |
|
Total de miembros
|
Context.MailingLists.ImportOperation.TotalMembers | integer |
El total de miembros. |
|
Message
|
Context.MailingLists.ImportOperation.Message | string |
Mensaje. |
|
Success
|
Context.MailingLists.ImportOperation.Success | boolean |
Si se realiza correctamente. |
Programación de una campaña
Asigna una fecha y hora programadas en las que se entregará la campaña.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de campaña
|
CampaignId | True | string |
Identificador de la campaña. |
|
Fecha y hora
|
DateTime | True | string |
Fecha y hora. |
|
Timezone
|
Timezone | string |
La zona horaria. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
Context
|
Context | string |
Contexto. |
Prueba de una campaña
Envía un correo electrónico de prueba de una campaña de borrador a una lista de direcciones de correo electrónico que especifique para obtener una vista previa.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de campaña
|
CampaignId | True | string |
Identificador de la campaña. |
|
Probar correos electrónicos
|
TestEmails | True | array of string |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
Context
|
Context | string |
Contexto. |
Quitar un campo personalizado
Quita una definición de campo personalizada de la lista de correo especificada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de lista de distribución de correo
|
MailingListId | True | string |
Identificador de la lista de distribución de correo. |
|
Id. de campo personalizado
|
CustomFieldId | True | string |
Identificador de campo personalizado. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
Context
|
Context | string |
Contexto. |
Quitar un suscriptor
Quita permanentemente un suscriptor de la lista de distribución de correo especificada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de lista de distribución de correo
|
MailingListId | True | string |
Identificador de la lista de distribución de correo. |
|
Correo Electrónico
|
True | string |
Dirección de correo electrónico. |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Código
|
Code | integer |
El código. |
|
Error
|
Error | string |
Error. |
|
Context
|
Context | string |
Contexto. |