El poder de integrar
EnvíaloSimple
+ HTTP API
+ Documentación
= Integración fácil
API EnvíaloSimple
Nuestra nueva API te permitirá integrar EnvíaloSimple con todas tus aplicaciones mediante simples llamadas a URLs, ofreciéndote innumerables funcionalidades, agrupadas por módulos para facilitar su utilización e implementación.
Podrás enviar tus campañas de email marketing; crear, modificar y eliminar contactos, listas de contactos y campañas; consultar estadísticas y reportes, y muchas más funcionalidades para que puedas integrarlo con tus aplicaciones.
Todas las URLs tienen la misma estructura: api.esmsv.com/v1/modulo/accion
modulo: Simboliza a un grupo de servicios. Por ejemplo: campaign, customfields, contacts, etc.
accion: Acción particular a realizar. Esta acción depende del módulo. Por ejemplo: create, edit, delete, etc.
Postman
Si utilizas Postman ponemos a disposición la colección de métodos para que importes en tu entorno.
Seteo de variables
Nuestra colección de métodos necesita de la parametrización de las siguientes variables de Postman para su correcto funcionamiento:
| Nombre | Valor |
|---|---|
| url | https://api.esmsv.com |
| token | I6Ik9UZzFNakUyTVRVME9USXpNVGM0TUE9PSIsIntyuHVlIjoiMm9y… |
Autenticación
Para utilizar la nueva API deberás contar con una Api key. Para esto deberás ingresar a tu cuenta, ir a Configuración > Clave Api y generar un nueva clave.Al utilizar los servicios deberá estar presente el método authorization en el header donde deberás enviar esta clave (token).
Ejemplo:
curl --location --request GET 'https://api.esmsv.com/v1/administrator/profile' --header 'Authorization: eyJpdiI6Ik9UZzFNakUyTVRVME9USXpNVGM0TUE9PSIsInZhbHVlIjoiMm9yaGZPYzZqNjVwL1haakw5SlovakNKcEZCeWpGaBcDEfGhIjklMNopqMD0iLCJtYWMiOiJhODVmNDgxZWUxYWoPu2Jktm1MjU0ZDhmNmUzMjA3NDliOGQwYWJkZWFlMjFkNDA4NmNiODRhMjYxIn0='
Aclaración: Si ya usabas la anterior Api y tenías creada una clave no podrás utilizar esa misma, sino que deberás crear una nueva.
Respuesta
Todas las respuestas tendrán dos secciones: status y code.
Adicionalmente, según el tipo de servicio, se agregarán otras secciones que se detallarán en cada uno de ellos.
| Nombre | Descripción |
|---|---|
| status | Aquí saldrá valor “ok” cuando el proceso se ejecute correctamente y “error” cuando exista algún error. |
| code | Aquí saldrá mensaje de éxito cuando el proceso se ejecute correctamente o un detalle cuando existan errores. |
Errores
Existen dos tipos de errores: de validación de datos de entrada (COD 422) y los particulares de cada servicio (COD 400). A continuación se detallan los errores de validación (COD 422) que son comunes a todos los servicios:
| Código | Descripción |
|---|---|
| is_not_accepted | Valor no aceptado. |
| invalid_url | URL inválida. |
| invalid_date | Fecha incorrecta. |
| invalid_alpha_format | El valor sólo debe contener letras. |
| invalid_alpha_dash_format | El valor sólo debe contener letras, números, guiones y guiones bajos. |
| invalid_alpha_num_format | El valor sólo debe contener letras y números. |
| invalid_array_format | El Valor debe ser un array. |
| attached | Este campo ya se adjuntó. |
| before_date | El valor debe ser una fecha anterior. |
| before_or_equal_date | El valor debe ser una fecha anterior o igual. |
| invalid_between_elements | Cantidad de elementos inválido. |
| invalid_between_size_file | Tamaño de archivo inválido. |
| invalid_between_number | Valor inválido. |
| invalid_between_characters | Cantidad de caracteres inválido. |
| invalid_boolean | El valor debe ser true o false. |
| invalid_value_confirmed | Valor confirmado inválido. |
| invalid_date_format | Formato de fecha inválido. |
| invalid_date_equal | Fecha incorrecta. |
| invalid_value_different | El valor debe ser diferente. |
| invalid_value_digits | Cantidad de digitos inválido. |
| invalid_value_digits_between | Cantidad de digitos inválido. |
| invalid_image_dimensions | Dimensiones de imagen inválidas. |
| value_duplicate | Valor duplicado. |
| invalid_email_format | El formato del email es incorrecto. |
| invalid_velue_ends_with | El valor ingresado es incorrecto. |
| not_exists | El campo es inválido. |
| is_not_file | El campo debe ser un archivo. |
| not_empty | El campo es obligatorio. |
| invalid_gt_elements | Cantidad de elementos inválido. |
| invalid_gt_size_file | Tamaño de archivo inválido. |
| invalid_gt_numeric | Valor incorrecto. |
| invalid_gt_characters | Cantidad de caracteres inválido. |
| invalid_gte_elements | Cantidad de elementos inválido. |
| invalid_gte_size_file | Tamaño del archivo inválido. |
| invalid_gte_numeric | Valor inválido. |
| invalid_gte_characters | Cantidad de caracteres inválido. |
| invalid_image | El campo debe ser una imagen. |
| invalid_value_in | Valor inválido. |
| invalid_value_in_array | Valor inválido. |
| invalid_value_integer | El campo debe ser un número entero. |
| invalid_value_ip | El campo debe ser una dirección IP válida. |
| invalid_ipv4_format | El campo debe ser una dirección IPv4 válida. |
| invalid_ipv6_format | El campo debe ser una dirección IPv6 válida. |
| invalid_json_format | El campo El campo debe ser una cadena JSON válida. |
| invalid_lt_elements | Cantidad de elementos inválido. |
| invalid_lt_size_file | Tamaño del archivo inválido. |
| invalid_lt_numeric | Valor inválido. |
| invalid_lt_characters | Cantidad de caracteres inválida. |
| invalid_lte_elements | Cantidad de elementos inválido. |
| invalid_lte_size_file | Tamaño del archivo inválido. |
| invalid_lte_numeric | Valor inválido. |
| invalid_lte_characters | Cantidad de caracteres inválido. |
| invalid_max_elements | Cantidad de elementos inválido. |
| invalid_max_size_file | Tamaño del archivo inválido. |
| invalid_max_numeric | Valor inválido. |
| invalid_max_characters | Cantidad de caracteres inválido. |
| invalid_mimes | Formato de archivo inválido. |
| invalid_mimetypes | Formato de archivo inválido. |
| invalid_min_elements | Cantidad de elementos inválido. |
| invalid_min_size_file | Tamaño de archivo inválido. |
| invalid_min_numeric | Valor inválido. |
| invalid_min_characters | Cantidad de caracteres inválido. |
| multiple_of | Valor inválido. |
| invalid_format | Formato de campo inválido. |
| only_numeric | El campo debe ser numérico. |
| invalid_password | Contraseña es incorrecta. |
| is_not_present | El campo debe estar presente. |
| prohibited | El campo está prohibido. |
| prohibited_if | El campo está prohibido. |
| prohibited_unless | El campo está prohibido. |
| relatable | El campo no se puede asociar con este recurso. |
| required | El campo es obligatorio. |
| is_not_same_that | El campo deben coincidir. |
| invalid_count_elements | Cantidad de elementos inválido. |
| invalid_size_file | Tamaño de archivo inválido. |
| invalid_size_number | Valor inválido. |
| invalid_count_characters | Cantidad de caracteres inválido. |
| invalid_value | Valor inválido. |
| only_characters | El campo debe ser una cadena de caracteres. |
| invalid_timezone | El campo debe ser una zona válida. |
| is_used | El campo ya ha sido registrado. |
| error_upload_file | Error al subir el archivo. |
| invalid_url_format | El formato tipo url del campo es inválido. |
| invalid_uuid_format | El campo debe ser un UUID válido. |
Automations 15
Este módulo te permitirá realizar toda la gestión asociada a automations desde la creación hasta la activación.
Description
Devuelve una lista de todos los automations. Pueden filtrarse por varios campos: nombre, estado y fecha creación.
Estructura de salida:
| Campo | Descripción |
|---|---|
| id | ID del automation |
| name | Título del automation |
| created | Fecha de creación del automation |
| schedule_type | Tipo de envío. Valores posibles:AutoresponderInmediate -> Apenas se detecte el eventoAutoresponderDeferred-> Programada |
| days_of_the_week | Días de la semana que puede enviarse |
| moment | Momento que se enviará el automation. Valores posibles:after -> Despues debefore -> Antes deonDay -> En el díaSolo se muestra si Tipo de envío = Programado |
| days | Cantidad de días. Solo se muestra si Tipo de envío = Programado y Momento = Antes de o Después de. |
| hour | Hora de envío. Solo se muestra si Tipo de envío = Programado |
| event | Evento disparador. Ver los posibles valores en: Obtener eventos disparadores de automation. |
| status | Estado del automation. Valores posibles:Draft -> BorradorPaused -> PausadoStopped -> DetenidoPendingforApproval -> Pendiente de aprobaciónSending -> Activo |
Body
| Key | Value | Description |
|---|---|---|
| filter | prueba | Filtro por nombre o parte del nombre del automation. |
| status | Sending | Filtro por estado del automation. Posible valores: Draft (Borrador) / Sending (Activo) / Paused (Pausado) / PendingForApproval (Pendiente de aprobación) / Stopped (Detenido) |
| createDateFrom | 2023-04-23 | Filtro por fecha de creación desde. Formato: YYYY-MM-DD. |
| createDateTo | 2023-05-28 | Filtro por fecha de creación hasta. Formato: YYYY-MM-DD. |
| limit | 10 | Cantidad de registros a mostrar por página. Máximo: 100. |
| page | 1 | Numero de página a mostrar. |
| orderBy | name | Criterio para ordenar los automations. Valores posibles: name/id. Por defecto: id. |
| order | desc | Tipo de ordenamiento. Valores posibles: asc/desc. Por defecto: desc. |
Description
Devuelve el detalle de un automation. Tener en cuenta que según el evento disparador y el tipo de envío se muestran distintos campos.
Estructura de salida:
| Campo | Descripcion |
|---|---|
| id | ID del automation |
| name | Título del automation |
| subject | Asunto |
| previewText | Texto de vista previa |
| fromAlias | Nombre del remitente |
| fromEmail | Desde |
| replyEmail | Responder a |
| event | Evento disparador. Ver los posibles valores en: Obtener eventos disparadores de automation. |
| maillists | Lista/s de contacto/s (ID y Nombre). Solo se muestra para Eventos = Suscripción a una lista, Desusucripción a una lista y Evento anual |
| idCustomField | Código de campo personalizado tipo Evento anual configurado. Sólo se muestra para Evento disparador = Evento anual |
| relCampaign | Id de campaña asociada al automation. Sólo se muestra para Eventos = Apertura, Clic en algún link, Clic en link específico y Sin clics en un link |
| url | Url de la campaña asociada al automation. Sólo se muestra para Eventos = Clic en link específico y Sin clics en un link |
| daysNoClick | Cantidad de días sin clic. Sólo se muestra para Evento = Sin clics en un link |
| created | Fecha de creación del automation |
| schedule_type | Tipo de envío. Valores posibles:AutoresponderInmediate -> Apenas se detecte el eventoAutoresponderDeferred-> Programada |
| moment | Momento que se enviará el automation. Valores posibles:after -> Despues debefore -> Antes deonDay -> En el díaSolo se muestra si Tipo de envío = Programado |
| days | Cantidad de días. Solo se muestra si Tipo de envío = Programado y Momento = Antes de o Después de. |
| hour | Hora de envío. Solo se muestra si Tipo de envío = Programado |
| daysOfTheWeek | Días de la semana que puede enviarse |
| status | Estado del automation. Valores posibles:Draft -> BorradorPaused -> PausadoStopped -> DetenidoPendingforApproval -> Pendiente de aprobaciónSending -> Activo |
| content | Contenido del automation en HTML |
| trackLinkClicks | Seguir enlaces |
| trackReads | Contar aperturas |
| trackAnalitics | Vincular con Google Analytics |
Errores:
| Código | Descripcion |
|---|---|
| errorMsg_automationNotFound | No existe automation con el ID informado. |
URL Variables
| Key | Value | Description |
|---|---|---|
| automation_id | 449 | Id de automation. Requerido |
Body
Description
Permite crear un nuevo automation. Sólo es requerido el Título y el Evento disparador.
Estructura de salida:
| Campo | Descripción |
|---|---|
| id | ID del automation creado |
| name | Título del automation |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_relCampaignNotActive | La campaña de referencia está en borrador. |
| errorMsg_relCampaignNotFound | No existe campaña con el ID informado. |
| errorMsg_relCampaignRequired | Es requerido informar la Campaña de referencia cuando se informa un Link. |
| errorMsg_mailListsIdsNotValid | No existe lista con el ID informado. |
| errorMsg_specificUrlInvalid | No existe el link informado. |
| errorMsg_idCFNotFound | No existe campo personalizado Tipo = Evento anual con el ID informado. |
| errorMsg_relCampaignIsNotAllowedByEvent | No está permitido informar Campaña de referencia para el Evento informado. |
| errorMsg_specificUrlIsNotAllowedByEvent | No está permitido informar Link específico para el Evento informado. |
| errorMsg_idCFIsNotAllowedByEvent | No está permitido informar Fecha específica para el Evento informado. |
| errorMsg_mailListsIdsIsNotAllowedByEvent | No está permitido informar Listas de contactos para el Evento informado. |
| errorMsg_daysNoClickIsNotAllowedByEvent | No está permitido informar Días sin clic para el Evento informado. |
| errorMsg_contentOrcontentUrlOrtemplateId | Sólo es posible ingresar uno de los campos: Contenido HTML o Url o Template. |
| errorMsg_TemplateIDNotFound | No existe plantilla con el ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| name | Promoción dia del padre | Título del automation. Requerido. |
| subject | Hola %Member:CustomField1% %Member:CustomField2% | Asunto del automation. Puedes incluir campos personalizados utilizando el “Código del campo personalizado” obtenido en el servicio “Obtener detalle de un campo personalizado”. |
| previewText | Texto para la vista previa | Texto de vista previa. |
| fromAlias | Empresa S.A. | Nombre del remitente. |
| fromEmail | administrador@ejemplo.com | Dirección de email desde la cuál saldrá el automation. Requerido solo si se completa el campo “fromAlias”. |
| replyEmail | administrador@ejemplo.com | Dirección email para “Responder a”. |
| content | %Member:CustomField1% %Member:CustomField2% ¡Mirá las promociones que tenemos para vos! | Contenido del email en Html. Puedes incluir campos personalizados utilizando el “Código del campo personalizado” obtenido en el servicio “Obtener detalle de un campo personalizado”. |
| contentUrl | http://google.com.ar | Generar contenido html del automation desde una url. |
| templateId | 65bceb74cf2a51360090a4b6 | Id de la plantilla. |
| event | click_ones | Evento disparador. Ver los posibles valores en: Obtener eventos diparadores. Requerido. |
| relCampaign | 230 | Id de campaña de referencia. Requerido si se informa un link específico. |
| specificUrl | http://www.google.com | Link específico de la campaña de referencia. Ver los posibles valores en: Obtener links de una campaña. |
| daysNoClick | 3 | Días sin clic. |
| mailListsIds[] | 36 | Array de Ids de listas de contactos. |
| idCF | 12 | Id de campo personalizado correspondiente a fecha específica. Ver los posibles valores en: Obtener colección de campos personalizados. |
| trackLinkClicks | 1 | Seguir enlaces. Valores posibles: 0/1. Por defecto 1. |
| trackReads | 0 | Contar aperturas. Valores posibles: 0/1. Por defecto 1. |
| trackAnalitics | 0 | Vincular con Google Analytics. Valores posibles: 0/1. Por defecto 1. |
Description
Permite editar todos los campos de un automation existente, teniendo en cuenta las siguientes consideraciones:
- Solo pueden modificarse automations en Borrador, Pausados o Detenidos.
- Si se desea blanquear los datos deben enviarse los parámetros con el valor en blanco.
- Al modificar un automation Detenido o Pausado, quedará en Borrador automáticamente.
Errores:
| Código | Descripción |
|---|---|
| errorMsg_automationNotFound | No existe automation con el ID informado. |
| errorMsg_nameIsRequired | No puede pasarse en blanco el Título del automation. |
| errorMsg_contentOrcontentUrlOrtemplateId | Sólo es posible ingresar uno de los campos: Contenido HTML o Url o Template. |
| errorMsg_TemplateIDNotFound | No existe plantilla con el ID informado. |
| errorMsg_automationSending | No es posible modificar un automation Activo. |
| errorMsg_automationPendingForApproval | No es posible modificar un automation en revisión. |
| errorMsg_relCampaignNotActive | La campaña de referencia está en borrador. |
| errorMsg_relCampaignNotFound | No existe campaña con el ID informado. |
| errorMsg_relCampaignRequired | Es requerido informar la Campaña de referencia cuando se informa un Link. |
| errorMsg_eventIsRequired | Es requerido informar Evento disparador cuando se informa Campaña o Link o Lista o Fecha específica o Días sin clic |
| errorMsg_mailListsIdsNotValid | No existe lista con el ID informado. |
| errorMsg_specificUrlInvalid | No existe el link informado. |
| errorMsg_idCFNotFound | No existe campo personalizado Tipo = Evento anual con el ID informado. |
| errorMsg_relCampaignIsNotAllowedByEvent | No está permitido informar Campaña de referencia para el Evento informado. |
| errorMsg_specificUrlIsNotAllowedByEvent | No está permitido informar Link específico para el Evento informado. |
| errorMsg_idCFIsNotAllowedByEvent | No está permitido informar Fecha específica para el Evento informado. |
| errorMsg_mailListsIdsIsNotAllowedByEvent | No está permitido informar Listas de contactos para el Evento informado. |
| errorMsg_daysNoClickIsNotAllowedByEvent | No está permitido informar Días sin clic para el Evento informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 577 | Id del automation. Requerido. |
| name | Prueba editar automation | Título del automation. |
| subject | Hola %Member:CustomField1% %Member:CustomField2% | Asunto del automation. Puedes incluir campos personalizados utilizando el “Código del campo personalizado” obtenido en el servicio “Obtener detalle de un campo personalizado”. |
| previewText | Texto de vista previa | Texto de vista previa. |
| fromAlias | Empresa S.A. | Nombre del remitente. |
| fromEmail | empresa@ejemplo.com | Dirección de email desde la cuál saldrá la campaña. Requerido solo si se completa el campo “fromAlias”. |
| replyEmail | correo@ejemplo.com | Dirección email para “Responder a”. |
| content | %Member:CustomField1% %Member:CustomField2% ¡Mirá las promociones que tenemos para vos! | Contenido del email en Html. Puedes incluir campos personalizados utilizando el “Código del campo personalizado” obtenido en el servicio “Obtener detalle de un campo personalizado”. |
| contentUrl | http://google.com.ar | Generar contenido html del automation desde una url. |
| templateId | 65bceb74cf2a51360090a4b6 | Id de la plantilla. |
| event | anual_event | Evento disparador. Ver los posibles valores en: Obtener eventos diparadores. Requerido. |
| relCampaign | 230 | Id de campaña de referencia. Requerido si se informa un link específico. |
| specificUrl | http://google.com | Link específico de la campaña de referencia. Ver los posibles valores en: Obtener links de una campaña. |
| daysNoClick | 3 | Días sin clic. |
| mailListsIds[] | 36 | Array de Ids de listas de contactos. |
| idCF | 3 | Id de campo personalizado correspondiente a fecha específica. Ver los posibles valores en: Obtener colección de campos personalizados. |
| trackLinkClicks | 0 | Seguir enlaces. Valores posibles: 0/1. Por defecto 1. |
| trackReads | 0 | Contar aperturas. Valores posibles: 0/1. Por defecto 1. |
| trackAnalitics | 0 | Vincular con Google Analytics. Valores posibles: 0/1. Por defecto 1. |
Description
Permite previsualizar los automations por email.Se enviará una vista previa del automation a los correos indicados. Si posee campos personalizados en el contenido: toma el valor de algún contacto de la lista asignada o cualquier contacto al azar en el caso que no posea lista.
Errores:
| Código | Descripción |
|---|---|
| errorMsg_automationNotFound | No existe automation con el ID informado. |
| errorMsg_warnPreviewLimit | Limite máximo de envíos diarios excedido. |
| errorMsg_notAllowed | No tiene permitido enviar vistas previas. |
Body
| Key | Value | Description |
|---|---|---|
| id | 590 | Id del automation. Requerido. |
| emails[] | correo@ejemplo.com | Array de emails. Requerido. Máximo: 5. |
Description
Permite previsualizar los automations por navegador.Devuelve un Html del automation para poder previsualizarlo en cualquier navegador. Si posee campos personalizados en el contenido: toma el valor del contacto indicado, sino toma algún contacto de la lista asignada, sino cualquier contacto al azar en el caso que no posea lista.
Errores:
| Código | Descripción |
|---|---|
| errorMsg_automationNotFound | No existe automation con el ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 590 | Id del automation. Requerido. |
| correo@ejemplo.com | Email utilizado para completar los campos personalizados incluidos en el automation. |
Description
Permite generar una miniatura del contenido del automation.
Errores:
| Código | Descripción |
|---|---|
| errorMsg_automationNotFound | No existe automation con el ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 578 | Id del automation. Requerido. |
| width | 300 | Ancho de la imagen. Requerido. Mínimo: 200, máximo: 600. |
| height | 600 | Alto de la imagen. Requerido. Mínimo: 200, máximo: 600. |
Description
Chequea si el automation cumple con todas las condiciones para poder ser activado. En la respuesta se incluirán tres secciones adicionales:
- canSend donde se indicará si el automation está en condiciones de ser activado.
- errors donde se mostrará un detalle de los motivos por los cuales no podrá ser activado, en caso de existir.
- warnings donde se mostrará un detalle de advertencias que si bien no impiden activar el automation indican cuestiones a mejorar, en caso de existir.
Errores:
| Código | Descripción |
|---|---|
| errorMsg_automationNotFound | No existe automation con el ID informado. |
| errorMsg_automationIntegrityFail-subject | Es necesario informar el campo subject. |
| errorMsg_automationIntegrityFail-replyTo | Es necesario informar el campo replyTo. |
| errorMsg_automationIntegrityFail-fromToName | Es necesario informar el campo fromToName. |
| errorMsg_automationIntegrityFail-fromTo | Es necesario informar el campo fromTo. |
| errorMsg_automationIntegrityFail-content | El automation no tiene contenido. |
| errorMsg_campaignSending | El automation está activo. |
| errorMsg_campaignPendingForApproval | El automation está pendiente de aprobación. |
| errorMsg_senderDomainNotVerified | El dominio no está verificado. |
| errorMsg_relCampaignNotFound | No existe campaña activa con el ID informado. |
| errorMsg_mailListsIdsNotValid | No existe lista con el ID informado. |
| errorMsg_noListSelected | En necesario informar una lista. |
| errorMsg_invalidCampaignSelected | En necesario informar una campaña. |
| errorMsg_invalidUrl | En necesario informar Url. |
| errorMsg_invalidCustomField | En necesario informar una fecha específica. |
| errorMsg_invalidDaysNoClick | En necesario informar días sin clics. |
| errorMsg_contactListFilter | No tienes permiso para activar automations. |
| errorMsg_spamRateErrorThreshold | El automation no pasó el chequeo de SPAM. |
| errorMsg_invalidMaillistsSelected | Alguna de las listas asociadas a al automation no existe. |
Advertencias:
| Código | Descripción |
|---|---|
| errorMsg_campaignIntegrityFail-subjectShort | El campo subject es corto |
| errorMsg_campaignIntegrityFail-subjectLong | El campo subject es largo. |
| errorMsg_spamRateWarningThreshold | El automation pasó el chequeo de SPAM, pero puedes mejorar el resultado. |
| errorMsg_senderDomainNotAuthenticated | Dominio no autenticado. |
| errorMsg_senderDmarcAllowedDomain | Se recomienda usar dominios propios para mantener una buena reputación y mejorar tu capacidad de entrega. |
Body
| Key | Value | Description |
|---|---|---|
| id | 221 | Id del automation. Requerido. |
Description
Devuelve un listado con todos los links de una campaña para la creación y/o edición de los automations cuyo evento disparador exige la url de la campaña (Eventos = Clic en link específico y Sin clics en un link)
Estructura de salida:
| Campo | Descripción |
|---|---|
| originalLink | Link para usar en el automation |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_campaignNotFound | No existe campaña con el ID informado o la misma está en borrador. |
Body
| Key | Value | Description |
|---|---|---|
| id | 1 | Id de la campaña. Requerido. |
Description
Devuelve un listado con los posibles Eventos disparadores para la creación y/o edición de los automations.
Detalle de los valores:
A continuación se deja una descripción de los valores actuales:
| Valor | Descripción |
|---|---|
| opener_campaign | Apertura de una campaña |
| click_any | Clic en algún link |
| click_one | Clic en un link específico |
| no_click_one | Sin clic en un periodo de tiempo específico |
| subscription | Suscripción a una lista de contactos |
| unsubscription | Desuscripción a una lista de contactos |
| anual_event | Evento anual |
Body
Description
Permite activar un automation en borrador, pausado o detenido.
Estructura de salida:
| Campo | Descripción |
|---|---|
| id | ID del automation activado |
| status | Pending |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_automationNotFound | No existe automation con el ID informado. |
| errorMsg_momentNotValid | No está permitida la opción seleccionada en Cuando enviar para el evento del automation. |
| errorMsg_automationIntegrityFail-subject | Es necesario informar el campo subject. |
| errorMsg_automationIntegrityFail-replyTo | Es necesario informar el campo replyTo. |
| errorMsg_automationIntegrityFail-fromToName | Es necesario informar el campo fromToName. |
| errorMsg_automationIntegrityFail-fromTo | Es necesario informar el campo fromTo. |
| errorMsg_automationIntegrityFail-content | El automation no tiene contenido. |
| errorMsg_campaignSending | El automation está activo. |
| errorMsg_campaignPendingForApproval | El automation está pendiente de aprobación. |
| errorMsg_senderDomainNotVerified | El dominio no está verificado. |
| errorMsg_relCampaignNotFound | No existe campaña activa con el ID informado. |
| errorMsg_mailListsIdsNotValid | No existe lista con el ID informado. |
| errorMsg_noListSelected | En necesario informar una lista. |
| errorMsg_invalidCampaignSelected | En necesario informar una campaña. |
| errorMsg_invalidUrl | En necesario informar Url. |
| errorMsg_invalidCustomField | En necesario informar una fecha específica. |
| errorMsg_invalidDaysNoClick | En necesario informar días sin clics. |
| errorMsg_contactListFilter | No tienes permiso para activar automations. |
| errorMsg_spamRateErrorThreshold | El automation no pasó el chequeo de SPAM. |
| errorMsg_invalidMaillistsSelected | Alguna de las listas asociadas a al automation no existe. |
Body
| Key | Value | Description |
|---|---|---|
| id | 590 | Id del automation. Requerido. |
| interval | 3 | Cantidad de días luego del evento. Requerido. Si interval = 0, se enviará apenas detectemos el evento; sino se enviará en un tiempo programado. |
| moment | after | Cuando enviar. Valores posibles: before (antes del evento) | onDay (en el día del evento) | after (después del evento). Requerido solo si Cantidad de días > 0. |
| time | 12 | Hora que se enviará. Requerido solo si interval > 0. |
| timeMinute | 15 | Minutos que se enviará. Requerido solo si Cantidad de días > 0. |
| days[] | 1 | Qué días de la semana se puede enviar. Valores posibles: 0 (Domingo) | 1 (Lunes) | 2 (Martes) | 3 (Miércoles) | 4 (Jueves) | 5 (Viernes) | 6 (Sábado). Requerido. |
Description
Permite eliminar un automation o varios a la vez, teniendo en cuenta que:
- Si se desea eliminar un solo automation, deberá pasarse como parámetro el id.
- Si se desea eliminar varios automation, deberá pasarse como parámetro un array de Ids. En caso de que algunos de los automations indicados no existan, los mismos se mostrarán en la respuesta dentro de automationsNotFound.
Errores:
| Código | Descripción |
|---|---|
| errorMsg_automationNotFound | No existe automation con el ID informado. |
| invalid_max_elements | Como máximo pueden eliminarse hasta 100 registros. Sólo para eliminación múltiple. |
Body
| Key | Value | Description |
|---|---|---|
| id | 470 | Id de automation a eliminar. Requerido sólo uno: id (para eliminación de un automation) o array de ids (para eliminación de varios automations). |
| ids[] | 6 | Array de Ids de automations a eliminar. Como máximo 100. Requerido sólo uno: id (para eliminación de una automation) o array de ids (para eliminación de varios automations). |
Description
Permite pausar un automation que está activo.
Estructura de salida:
| Campo | Descripción |
|---|---|
| id | ID del automation pausado. |
| status | Paused |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_automationNotFound | No existe automation con el ID informado. |
| errorMsg_automationNotActive | El automation está en borrador. |
| errorMsg_automationPaused | El automation ya está pausado. |
| errorMsg_automationStopped | El automation está detenido. |
Body
| Key | Value | Description |
|---|---|---|
| id | 457 | Id de automation. Requerido. |
Description
Permite reanudar un automation detenido o pausado.
Estructura de salida:
| Campo | Descripción |
|---|---|
| id | ID del automation reanudado |
| status | Pending |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_automationNotFound | No existe automation con el ID informado. |
| errorMsg_automationSending | El automation está activo. |
| errorMsg_automationPendingForApproval | El automation está pendiente de aprobación . |
| errorMsg_automationNotPausedOrStopped | El automation está en borrador. |
Body
| Key | Value | Description |
|---|---|---|
| id | 457 | Id de automation. Requerido. |
Description
Permite duplicar un automation.
Estructura de salida:
| Campo | Descripción |
|---|---|
| id | ID del automation nuevo |
| name | Nombre del automation nuevo |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_automationNotFound | No existe automation con el ID informado. |
URL Variables
| Key | Value | Description |
|---|---|---|
| automation_id | 590 | Id del automation. Requerido. |
Campañas 15
Este módulo te permitirá realizar toda la gestión asociada a campañas desde la creación hasta el envío.
Description
Devuelve una lista de todas las campañas. Pueden filtrarse por varios campos: nombre, estado, tipo de envío, fecha creación y fecha de envío.
Estructura de salida:
| Campo | Descripción |
|---|---|
| id | ID de la campaña |
| name | Título de la campaña |
| created | Fecha de creación de la campaña |
| type_send | Tipo de envío. Valores posibles:Send Now -> Enviar ahoraOne time scheduled -> ProgramadaNot scheduled -> Sin programar |
| status | Estado de la campaña. Valores posibles:Draft -> BorradorPaused -> PausadaStopped -> DetenidaPendingforApproval -> Pendiente de aprobaciónSending -> Enviando o ProgramadaCompleted -> Enviada |
| recipients_count | Cantidad de destinatarios |
| schedule_send_date | Fecha de programación de la campañaSólo para campañas con Tipo de envío = Programada |
| start_date | Fecha de inicio de envío |
| finish_date | Fecha fin del envío |
Body
| Key | Value | Description |
|---|---|---|
| filter | Promo | Filtro por nombre o parte del nombre de la campaña. |
| status | Draft | Filtro por estado de la campaña. Posible valores: Draft (Borrador) / Completed (Enviada) / Sending (Enviandose o Programada) / Paused (Pausada) / PendingForApproval (Pendiente de aprobación) / Stopped (Detenida) |
| typeSend | sendNow | Filtro por tipo de envío. Posibles valores: sendNow (Enviar ahora) / scheduled (Programada). |
| createDateFrom | 2021-05-01 | Filtro por fecha de creación desde. Formato: YYYY-MM-DD. |
| createDateTo | 2021-05-28 | Filtro por fecha de creación hasta. Formato: YYYY-MM-DD. |
| sendDateFrom | 2021-05-01 | Filtro por fecha de envío desde. Formato: YYYY-MM-DD. |
| sendDateTo | 2021-05-28 | Filtro por fecha de envío hasta. Formato: YYYY-MM-DD. |
| limit | 10 | Cantidad de registros a mostrar por página. Máximo: 100. |
| page | 1 | Numero de página a mostrar. |
| orderBy | name | Criterio para ordenar las campañas. Valores posibles: name/id. Por defecto: id. |
| order | asc | Tipo de ordenamiento. Valores posibles: asc/desc. Por defecto: desc. |
Description
Devuelve el detalle de una campaña. Tener en cuenta que:
- Para las campañas que son reenvíos se mostrará además: la campaña original y el tipo de reenvío.
- Para las campañas que tienen reenvíos automáticos configurados se mostrará además: tipo de reenvío, cantidad de días y horario.
Estructura de salida:
| Campo | Descripcion |
|---|---|
| id | ID de la campaña |
| name | Título de la campaña |
| created | Fecha de creación de la campaña |
| subject | Asunto |
| previewText | Texto de vista previa |
| fromAlias | Nombre del remitente |
| fromEmail | Desde |
| replyEmail | Responder a |
| maillists | Lista/s de contacto/s (ID y Nombre) |
| segments | Segmento (ID y nombre) |
| recipients_count | Total de destinatarios de la campaña |
| type_send | Tipo de envío. Valores posibles:Send Now -> Enviar ahoraOne time scheduled -> ProgramadaNot scheduled -> Sin programar |
| schedule_send_date | Fecha de programación de la campañaSólo para campañas con Tipo de envío = Programada |
| start_date | Fecha de inicio de envío |
| finish_date | Fecha fin del envío |
| trackLinkClicks | Seguir enlaces |
| trackReads | Contar aperturas |
| trackAnalitics | Vincular con Google Analytics |
| sendReport | Enviar informe |
| publicArchive | Agregar al archivo público |
| workspace | Cómo fue realizado el contenido. Valores posibles:designer -> Editor visualexpertCoder -> Modo programadorexternalUrl -> Modo Url |
| content | Contenido de la campaña en HTML |
| status | Estado de la campaña. Valores posibles:Draft -> BorradorPaused -> PausadaStopped -> DetenidaPendingforApproval -> Pendiente de aprobaciónSending -> Enviando o ProgramadaCompleted -> Enviada |
| resend.ofCampaign | Campaña de la cúal es reenvío. Sólo se muestra para las campañas que son reenvíos de otras. |
| resend.type | Tipo de reenvío. Valores posibles:1 -> A los contactos que no abrieron la campaña2 -> A los contactos que no hicieron click sobre el contenido3 -> A los contactos que tuvieron rebotes blandos4 -> Nuevamente a todos los contactos |
| resend.days | Días para el reenvío. Sólo se muestra para las campañas que tienen reenvíos automáticos configurados. |
| resend.hours | Hora de reenvío. Sólo se muestra para las campañas que tienen reenvíos automáticos configurados. |
| resend.mins | Minutos de reenvío. Sólo se muestra para las campañas que tienen reenvíos automáticos configurados. |
Errores:
| Código | Descripcion |
|---|---|
| errorMsg_campaignNotFound | No existe campaña con el ID informado. |
URL Variables
| Key | Value | Description |
|---|---|---|
| campaing_id | 12 | Id de campaña. Requerido. |
Body
Description
Permite crear una nueva campaña. Sólo es requerido el Título.
Estructura de salida:
| Campo | Descripción |
|---|---|
| id | ID de la campaña creada |
| name | Título de la campaña |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_mailListsIdsOrSegmentId | Sólo es posible ingresar uno de los campos: Lista/s o Segmentos. |
| errorMsg_contentOrcontentUrlOrtemplateId | Sólo es posible ingresar uno de los campos: Contenido HTML o Url o Template. |
| errorMsg_TemplateIDNotFound | No existe plantilla con el ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| name | Promociones día del padre | Título de la campaña. Requerido. |
| subject | Hola %Member:CustomField1% %Member:CustomField2% | Asunto de la campaña. Puedes incluir campos personalizados utilizando el “Código del campo personalizado” obtenido en el servicio “Obtener detalle de un campo personalizado”. |
| previewText | Texto para la vista previa | Texto de vista previa. |
| fromAlias | Empresa S.A. | Nombre del remitente. |
| fromEmail | administrador@ejemplo.com | Dirección de email desde la cuál saldrá la campaña. Requerido solo si se completa el campo “fromAlias”. |
| replyEmail | administrador@ejemplo.com | Dirección email para “Responder a”. |
| mailListsIds[] | 1 | Array de Ids de listas de contactos. |
| segmentId | 19 | Id del segmento. |
| content | %Member:CustomField1% %Member:CustomField2% ¡Mirá las promociones que tenemos para vos! | Contenido del email en Html. Puedes incluir campos personalizados utilizando el “Código del campo personalizado” obtenido en el servicio “Obtener detalle de un campo personalizado”. |
| contentUrl | http://google.com.ar | Generar contenido html de la campaña desde una url. |
| templateId | 65983f41755d4e4c00e21007 | Id de la plantilla. |
| trackLinkClicks | 1 | Seguir enlaces. Valores posibles: 0/1. Por defecto 1. |
| trackReads | 0 | Contar aperturas. Valores posibles: 0/1. Por defecto 1. |
| trackAnalitics | 0 | Vincular con Google Analytics. Valores posibles: 0/1. Por defecto 1. |
| sendReport | 0 | Enviar reporte. Valores posibles: 0/1. Por defecto 1. |
| publicArchive | 1 | Agregar al archivo público. Valores posibles: 0/1. Por defecto 0. |
Description
Permite editar todos los campos de una campaña existente, teniendo en cuenta las siguiente consideraciones:
- Solo pueden modificarse campañas en Borrador o Detenidas.
- Si se desea blanquear los datos deben enviarse los parámetros con el valor en blanco.
- Al modificar un campaña Detenida la misma quedará en Borrador automáticamente.
- En caso de que alguna de las listas indicadas no exista, la misma se mostrará en la respuesta dentro de mailListsNotFound y no se asignará a la campaña.
- En caso de que el segmento indicado no exista, el mismo se mostrará en la respuesta dentro de segmentNotFound y no se asignará a la campaña.
Errores:
| Código | Descripción |
|---|---|
| errorMsg_campaignNotFound | No existe campaña con el ID informado. |
| errorMsg_mailListsIdsOrSegmentId | Sólo es posible ingresar uno de los campos: Lista/s o Segmentos. |
| errorMsg_contentOrcontentUrlOrtemplateId | Sólo es posible ingresar uno de los campos: Contenido HTML o Url o Template. |
| errorMsg_TemplateIDNotFound | No existe plantilla con el ID informado. |
| errorMsg_campaignPaused | La campaña está pausada. |
| errorMsg_campaignSending | La campaña está enviándose o programada. |
| errorMsg_campaignPendingForApprova | La campaña está pendiente de aprobación. |
| errorMsg_campaignCompleted | La campaña está enviada. |
Body
| Key | Value | Description |
|---|---|---|
| id | 4 | Id de la campaña. Requerido. |
| name | Prueba editar campaña | Nombre de la campaña. |
| subject | Hola %Member:CustomField1% %Member:CustomField2% | Asunto de la campaña. Puedes incluir campos personalizados utilizando el “Código del campo personalizado” obtenido en el servicio “Obtener detalle de un campo personalizado”. |
| previewText | Texto de vista previa | Texto de vista previa. |
| fromAlias | Empresa S.A. | Nombre del remitente. |
| fromEmail | empresa@ejemplo.com | Dirección de email desde la cuál saldrá la campaña. Requerido solo si se completa el campo “fromAlias”. |
| replyEmail | correo@ejemplo.com | Dirección email para “Responder a”. |
| mailListsIds[] | 2 | Array de Ids de listas de contactos. |
| segmentId | 1 | Id del segmento. |
| content | %Member:CustomField1% %Member:CustomField2% ¡Mirá las promociones que tenemos para vos! | Contenido del email en Html. Puedes incluir campos personalizados utilizando el “Código del campo personalizado” obtenido en el servicio “Obtener detalle de un campo personalizado”. |
| contentUrl | http://google.com.ar | Generar contenido html de la campaña desde una url. |
| templateId | 65bceb74cf2a51360090a4b6 | Id de la plantilla. |
| trackLinkClicks | 0 | Seguir enlaces. Valores posibles: 0/1. Por defecto 1. |
| trackReads | 0 | Contar aperturas. Valores posibles: 0/1. Por defecto 1. |
| trackAnalitics | 0 | Vincular con Google Analytics. Valores posibles: 0/1. Por defecto 1. |
| sendReport | 0 | Enviar reporte. Valores posibles: 0/1. Por defecto 1. |
| publicArchive | 1 | Agregar al archivo público. Valores posibles: 0/1. Por defecto 0. |
Description
Permite previsualizar las campañas por email.Se enviará una vista previa de la campaña a los correos indicados. Si posee campos personalizados en el contenido: toma el valor de algún contacto de la lista asignada o cualquier usuario al azar en el caso que no posea lista.
Errores:
| Código | Descripción |
|---|---|
| errorMsg_campaignNotFound | No existe campaña con el ID informado. |
| errorMsg_warnPreviewLimit | Limite máximo de envíos diarios excedido. |
| errorMsg_notAllowed | No tiene permitido enviar vistas previas. |
Body
| Key | Value | Description |
|---|---|---|
| id | 1 | Id de la campaña. Requerido. |
| emails[] | correo@ejemplo.com | Array de emails. Requerido. Máximo: 5. |
Description
Permite previsualizar las campañas por navegador.Devuelve un Html de la campaña para poder previsualizarla en cualquier navegador. Si posee campos personalizados en el contenido: toma el valor del contacto indicado, sino toma algún contacto de la lista asignada, sino cualquier usuario al azar en el caso que no posea lista.
Errores:
| Código | Descripción |
|---|---|
| errorMsg_campaignNotFound | No existe campaña con el ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 1 | Id de la campaña. Requerido. |
| correo@ejemplo.com | Email utilizado para completar los campos personalizados incluidos en la campaña. Si no se envía este dato y la campaña posee campos personalizados los mismos se completarán con datos de contactos al azar. |
Description
Chequea si la campaña cumple con todas las condiciones para poder ser enviada. En la respuesta se incluirán tres secciones adicionales:
- canSend donde se indicará si la campaña está en condiciones de ser enviada o no.
- errors donde se mostrará un detalle de los motivos por los cuales no podrá ser enviada la campaña, en caso de existir.
- warnings donde se mostrará un detalle de advertencias que si bien no impiden enviar la campaña indican cuestiones a mejorar, en caso de existir.
Errores:
| Código | Descripción |
|---|---|
| errorMsg_campaignNotFound | No existe campaña con el ID informado. |
| errorMsg_campaignIntegrityFail-subject | Es necesario completar el campo subject. |
| errorMsg_campaignIntegrityFail-replyTo | Es necesario completar el campo replyTo. |
| errorMsg_campaignIntegrityFail-fromToName | Es necesario completar el campo fromToName. |
| errorMsg_campaignIntegrityFail-fromTo | Es necesario completar el campo fromTo. |
| errorMsg_campaignIntegrityFail-content | La campaña no tiene contenido. |
| errorMsg_noListNoSegmentSelected | Es necesario asociar una lista de emails o un segmento. |
| errorMsg_campaignPendingForApproval | La campaña está pendiente de aprobación. |
| errorMsg_campaignCompleted | La campaña está enviada. |
| errorMsg_maxSimultaneousCampaignLimitExceeded | Alcanzó el limite máximo de campañas enviándose simultáneamente. |
| errorMsg_senderDomainNotVerified | El dominio no está verificado. |
| errorMsg_noContactsInMailLists | Alguna de las listas no poseen contactos. |
| errorMsg_noContactsInSegments | El segmento no posee contactos. |
| errorMsg_contactListFilter | No tienes permiso para enviar campañas. |
| errorMsg_spamRateErrorThreshold | La campaña no pasó el chequeo de SPAM. |
| errorMsg_invalidMaillistsSelected | Alguna de las listas asociadas a la campaña no existe. |
Advertencias:
| Código | Descripción |
|---|---|
| errorMsg_campaignIntegrityFail-subjectShort | El campo subject es corto |
| errorMsg_campaignIntegrityFail-subjectLong | El campo subject es largo. |
| errorMsg_spamRateWarningThreshold | La campaña pasó el chequeo de SPAM, pero puedes mejorar el resultado. |
| errorMsg_senderDomainNotAuthenticated | Dominio no autenticado. |
| errorMsg_senderDmarcAllowedDomain | Se recomienda usar dominios propios para mantener una buena reputación y mejorar tu capacidad de entrega. |
Body
| Key | Value | Description |
|---|---|---|
| id | 3 | Id de la campaña. Requerido. |
Description
Permite enviar una campaña en borrador o detenida, teniendo en cuenta que:
- Si la campaña está en borrador, siempre hay que indicar el campo Enviar ahora.
- Si la campaña está detenida, si se indica el campo Enviar ahora tomará el valor indicado, caso contrario se reanudará con los valores que ya tenga configurado.
Además, podrá programarse un reenvío automático.
Estructura de salida:
| Campo | Descripción |
|---|---|
| id | ID de la campaña enviada |
| status | Pending |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_campaignPaused | La campaña está pausada. |
| errorMsg_campaignSending | La campaña está enviándose o programada. |
| errorMsg_campaignPendingForApproval | La campaña está pendiente de aprobación. |
| errorMsg_campaignCompleted | La campaña está enviada. |
| errorMsg_campaignNotFound | No existe campaña con el ID informado. |
| errorMsg_campaignIntegrityFail-subject | Es necesario completar el campo subject. |
| errorMsg_campaignIntegrityFail-replyTo | Es necesario completar el campo replyTo. |
| errorMsg_campaignIntegrityFail-fromToName | Es necesario completar el campo fromToName. |
| errorMsg_campaignIntegrityFail-fromTo | Es necesario completar el campo fromTo. |
| errorMsg_campaignIntegrityFail-content | La campaña no tiene contenido. |
| errorMsg_noListNoSegmentSelected | Es necesario asociar una lista de emails o un segmento. |
| errorMsg_maxSimultaneousCampaignLimitExceeded | Alcanzó el limite máximo de campañas enviándose simultáneamente. |
| errorMsg_senderDomainNotVerified | El dominio no está verificado. |
| errorMsg_noContactsInMailLists | Alguna de las listas no poseen contactos. |
| errorMsg_noContactsInSegments | El segmento no posee contactos. |
| errorMsg_contactListFilter | No tienes permiso para enviar campañas. |
| errorMsg_spamRateErrorThreshold | La campaña no pasó el chequeo de SPAM. |
| errorMsg_invalidMaillistsSelected | Alguna de las listas asociadas a la campaña no existe. |
Body
| Key | Value | Description |
|---|---|---|
| id | 4 | Id de la campaña. Requerido. |
| sendNow | 0 | Enviar ahora. Valores posibles: 1 (Enviar ahora) y 0 (Programar). Sólo es requerido cuando la campaña está en borrador. |
| sendDate | 2022-12-31 11:00:00 | Fecha de programación de la campaña. Formato: YYYY-MM-DD HH:MM:DD. Tiene que ser mayor a la fecha y hora actual. Requerido, si sendNow = 0 (Programar). |
| resend | 1 | Programar reenvío. Valores posibles: 0 (No) y 1 (Sí). Por defecto 0. |
| resendType | 2 | Tipo de reenvío. Requerido si Programar reenvío = 1. Valores posibles: 1 (A los contactos que no abrieron la campaña) / 2 (A los contactos que no hicieron click sobre el contenido) / 3 (A los contactos que tuvieron rebotes blandos) / 4 (Nuevamente a todos los contactos) |
| resendDays | 7 | Cantidad de días para el reenvío. Requerido si Programar reenvío = 1. Máximo 999, mínimo: 1. |
| resendHours | 17 | Hora para reenvío. Requerido si Programar reenvío = 1. Máximo 23, mínimo: 0. |
| resendMins | 40 | Minutos para reenvío. Requerido si Programar reenvío = 1. Máximo 59, mínimo: 0. |
Description
Permite pausar una campaña que está enviándose, programada o en revisión.
Estructura de salida:
| Campo | Descripción |
|---|---|
| id | ID de la campaña pausada. |
| status | Paused |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_campaignNotFound | No existe campaña con el ID informado. |
| errorMsg_campaignNotActive | La campaña está en borrador. |
| errorMsg_campaignPaused | La campaña ya está pausada. |
| errorMsg_campaignCompleted | La campaña está enviada. |
| errorMsg_campaignStopped | La campaña está detenida. |
| errorMsg_campaignNotPaused | La campaña no pudo ser pausada. |
Body
| Key | Value | Description |
|---|---|---|
| id | 112 | Id de campaña. Requerido. |
Description
Permite detener una campaña que está enviándose, programada, en revisión o pausada.
Estructura de salida:
| Campo | Descripción |
|---|---|
| id | ID de la campaña detenida |
| status | Stopped |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_campaignNotFound | No existe campaña con el ID informado. |
| errorMsg_campaignNotActive | La campaña está en borrador. |
| errorMsg_campaignCompleted | La campaña está enviada. |
| errorMsg_campaignStopped | La campaña ya está detenida. |
| errorMsg_campaignNotStopped | La campaña no pudo ser detenida. |
Body
| Key | Value | Description |
|---|---|---|
| id | 112 | Id de campaña. Requerido. |
Description
Permite reanudar una campaña detenida o pausada.
Estructura de salida:
| Campo | Descripción |
|---|---|
| id | ID de la campaña reanudada |
| status | Sending |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_campaignNotFound | No existe campaña con el ID informado. |
| errorMsg_campaignSending | La campaña está enviándose o programada. |
| errorMsg_campaignPendingForApproval | La campaña está pendiente de aprobación . |
| errorMsg_campaignCompleted | La camapaña está enviada. |
| errorMsg_campaignNotPausedOrStopped | La campaña está en borrador. |
| campaignBlocked | Se detectaron ciertos inconvenientes en el contenido de tu campaña. |
Body
| Key | Value | Description |
|---|---|---|
| id | 127 | Id de campaña. Requerido. |
Description
Permite eliminar una campaña o varias a la vez, teniendo en cuenta que:
- Si se desea eliminar una sola campaña, deberá pasarse como parámetro el id.
- Si se desea eliminar varias campañas, deberá pasarse como parámetro un array de Ids. En caso de que algunas de las campañas indicadas no existan, las mismas se mostrarán en la respuesta dentro de campaignsNotFound.
Errores:
| Código | Descripción |
|---|---|
| errorMsg_campaignNotFound | No existe campaña con el ID informado. |
| invalid_max_elements | Como máximo pueden eliminarse hasta 100 registros. Sólo para eliminación múltiple. |
Body
| Key | Value | Description |
|---|---|---|
| id | 113 | Id de campaña a eliminar. Requerido sólo uno: id (para eliminación de una campaña) o array de ids (para eliminación de varias campañas). |
| ids[] | 6 | Array de Ids de campañas a eliminar. Como máximo 100. Requerido sólo uno: id (para eliminación de una campaña) o array de ids (para eliminación de varias campañas). |
Description
Permite duplicar una campaña.
Estructura de salida:
| Campo | Descripción |
|---|---|
| id | ID de la campaña nueva |
| name | Nombre de la campaña nueva |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_campaignNotFound | No existe campaña con el ID informado. |
URL Variables
| Key | Value | Description |
|---|---|---|
| campaing_id | Id de campaña. Requerido. |
Description
Permite reenviar una campaña.
Estructura de salida:
| Campo | Descripción |
|---|---|
| id | ID de la campaña reenviada |
| name | Nombre de la campaña reenviada |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_campaignNotFound | No existe campaña con el ID informado. |
| errorMsg_emptyMaillistsOrSegment | La campaña no se puede reenviar porque la lista de contactos o el segmento ya no existe. |
| errorMsg_campaignNotCompleted | La campaña no fue enviada. |
Body
| Key | Value | Description |
|---|---|---|
| id | 11 | Id de la campaña a reenviar. Requerido. |
| type | 4 | Tipo de reenvío. Requerido. Valores posibles: 1 (A los contactos que no abrieron la campaña) / 2 (A los contactos que no hicieron click sobre el contenido) / 3 (A los contactos que tuvieron rebotes blandos) / 4 (Nuevamente a todos los contactos) |
| sendNow | 1 | Enviar ahora. Requerido. Valores posibles: 1 (Enviar ahora) y 0 (Programar). |
| sendDate | 2022-12-31 11:00:00 | Fecha de programación del reenvío. Formato: YYYY-MM-DD HH:MM:DD. Tiene que ser mayor a la fecha y hora actual. Requerido, si sendNow = 0 (Programar). |
Description
Permite generar una miniatura del contenido de la campaña.
Errores:
| Código | Descripción |
|---|---|
| errorMsg_campaignNotFound | No existe campaña con el ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 26 | Id de la campaña. Requerido. |
| width | 300 | Ancho de la imagen. Requerido. Mínimo: 200, máximo: 600. |
| height | 600 | Alto de la imagen. Requerido. Mínimo: 200, máximo: 600. |
Campos personalizados 7
Este módulo agrupa servicios para la gestión de campos personalizados utilizados para la información de los contactos, los formularios de suscripción y la personalización de tus campañas.
Description
Devuelve una lista con todos los campos personalizados. Pueden filtrarse por nombre.
Estructura de salida:
| Campo | Descripción |
|---|---|
| id | ID del campo personalizado |
| name | Nombre del campo personalizado |
| code | Código del campo personalizado.Con este código podrás incluir los campos personalizados en el asunto y contenido de la campaña |
| type | Tipo de campo. Ver los posibles valores en: Obtener tipos de campos personalizados |
| validation | Tipo de validación. Ver los posibles valores en: Obtener validaciones de campos personalizados. Se muestra solo para Tipo de campo = Campo de texto o Campo oculto |
| validationCustomRegExp | Validación personalizada. Se muestra solo si Validación = Personalizada) |
| options_values | Opciones posibles. Se muestra solo para Tipo de campo = Listado o Listado con selección múltiple o Listado con selección única |
| value_default | Valor por defecto. Se muestra solo para Tipo de campo = Campo de texto o Campo oculto o Evento anual |
| date_value | Fecha por defecto. Se muestra solo para Tipo de campo = Evento anual |
Body
| Key | Value | Description |
|---|---|---|
| name | campo | Filtro por nombre o parte del nombre del campo personalizado. |
| type | Text field | Filtro por tipo de campo. Ver los posibles valores en: Obtener tipos de campos personalizados. |
| limit | 10 | Cantidad de registros a mostrar por página. Máximo: 100. |
| page | 1 | Numero de página a mostrar. |
| orderBy | name | Criterio para ordenar los campos. Valores posibles: nombre/id. Por defecto: id. |
| order | asc | Tipo de ordenamiento. Valores posibles: asc/desc. Por defecto: desc. |
Description
Devuelve el detalle de un campo personalizado.
Estructura de salida:
| Campo | Descripción |
|---|---|
| id | ID del campo personalizado. |
| name | Nombre del campo personalizado |
| code | Código del campo personalizado.Con este código podrás incluir los campos personalizados en el asunto y contenido de la campaña |
| type | Tipo de campo. Ver los posibles valores en: Obtener tipos de campos personalizados |
| validation | Tipo de validación. Ver los posibles valores en: Obtener validaciones de campos personalizados Se muestra solo para Tipo de campo = Campo de texto o Campo oculto. |
| validationCustomRegExp | Validación personalizada. Se muestra solo si Validación = Personalizada) |
| options_values | Opciones posibles. Se muestra solo para Tipo de campo = Listado o Listado con selección múltiple o Listado con selección única |
| value_default | Valor por defecto. Se muestra solo para Tipo de campo = Campo de texto o Campo oculto o Evento anual |
| date_value | Fecha por defecto. Se muestra solo para Tipo de campo = Evento anual |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_customFieldNotFound | No existe campo personalizado con el ID informado. |
URL Variables
| Key | Value | Description |
|---|---|---|
| customfield_id | 3 | Id del campo personalizado. |
Description
Devuelve un listado de tipos de validaciones que serán utilizados en la creación y/o edición de los campos personalizados tipo = Campo de texto o Campo oculto.
Detalle de los valores:
A continuación se deja una descripción de los valores actuales:
| Valor | Descripción |
|---|---|
| Do not Apply | Desactivar |
| Numeric Only | Aceptar sólo dígitos |
| Alpha Only | Aceptar solo letras y espacios |
| Alpha Numeric Only | Aceptar solo letras, números y espacios |
| Email Format Check | Aceptar sólo direcciones de correo |
| Custom | Personalizada |
Description
Devuelve un listado de tipos de campos que serán utilizados en la creación y/o edición de los campo personalizados.
Detalle de los valores:
A continuación se deja una descripción de los valores actuales:
| Valor | Descripción |
|---|---|
| Text field | Campo de texto |
| Hidden field | Campo oculto |
| Check box | Listado con selección múltiple |
| Radio button | Listado con selección única |
| Anual Date | Evento anual |
| Drop list | Listado |
Description
Permite crear un nuevo campo personalizado, teniendo en cuenta las siguientes consideraciones:
- Siempre será requerido: Nombre y Tipo de campo.
- Para campos tipo = Campo de texto o Campo oculto, siempre se pedirán los siguientes parámetros:
- Tipo de validación. Es requerido indicar un valor.
- Expresión regular. Es requerido indicar un valor para Validación = Personalizada.
- Valor por defecto. No es requerido indicar un valor por lo que puede quedar en blanco.
- Para Tipo de campo = Listado o Listado con selección múltiple o Listado con selección única siempre se pedirá el parámetro Opciones, siendo requerido indicar un valor.
- Para Tipo de campo = Evento anual, siempre se pedirá el parámetro Valor por defecto pero no es requerido indicar un valor por lo que puede quedar en blanco.
Errores:
| Código | Descripción |
|---|---|
| valueDefaultWithValidationCustomRegExp | El valor por defecto no cumple con la validación personalizada. |
Body
| Key | Value | Description |
|---|---|---|
| name | Apellido | Nombre del campo. Requerido. |
| type | Text field | Tipo de campo. Ver los posibles valores en: Obtener tipos de campos personalizados. Requerido. |
| validation_type | Do not Apply | Tipo de validación. Ver los posibles valores en: Obtener validaciones de campos personalizados. Requerido. si Tipo de campo = Campo de texto o Campo oculto. |
| validationCustomRegExp | /^[0-9]*$/ | Expresion regular para la validación del campo. Requerido para Validación = Personalizada. |
| value_default | Desconocido | Valor por defecto. Requerido para Tipo de campo = Campo de texto o Campo oculto. Puede quedar en blanco el valor. |
| options_values[] | Opción1 | Array con valores de las opciones. Es requerido indicar al menos una opción con valor para Tipo de campo = Listado o Listado con selección múltiple o Listado con selección única. |
| date_value | 02-28 | Fecha anual por defecto. Formato: MM-DD. Requerido para Tipo de campo = Evento anual. Puede quedar en blanco el valor. |
Description
Permite editar un campo personalizado, teniendo en cuenta las siguientes consideraciones:
- Siempre será requerido: Nombre y Tipo de campo.
- Para campos tipo = Campo de texto o Campo oculto, siempre se pedirán los siguientes parámetros:
- Tipo de validación. Es requerido indicar un valor.
- Expresión regular. Es requerido indicar un valor para Validación = Personalizada.
- Valor por defecto. No es requerido indicar un valor por lo que puede quedar en blanco.
- Para Tipo de campo = Listado o Listado con selección múltiple o Listado con selección única siempre se pedirá el parámetro Opciones, siendo requerido indicar un valor.
- Para Tipo de campo = Evento anual, siempre se pedirá el parámetro Valor por defecto pero no es requerido indicar un valor por lo que puede quedar en blanco.
Errores:
| Código | Descripcion |
|---|---|
| errorMsg_customFieldNotFound | No existe campo personalizado con el ID informado. |
| valueDefaultWithValidationCustomRegExp | El valor por defecto no cumple con la validación personalizada. |
Body
| Key | Value | Description |
|---|---|---|
| id | 8 | Id de campo personalizado a modificar. Requerido. |
| name | Fecha de nacimiento | Nombre del campo. Requerido. |
| type | Anual Date | Tipo de campo. Ver los posibles valores en: Obtener tipos de campos personalizados. Requerido. |
| validation_type | Custom | Tipo de validación. Ver los posibles valores en: Obtener validaciones de campos personalizados. Requerido. si Tipo de campo = Campo de texto o Campo oculto. |
| validationCustomRegExp | /^[0-9]*$/ | Expresion regular para la validación del campo. Requerido para Validación = Personalizada. |
| value_default | Desconocido | Valor por defecto. Requerido para Tipo de campo = Campo de texto o Campo oculto. Puede quedar en blanco el valor. |
| options_values[] | Opción1 | Array con valores de las opciones. Es requerido indicar al menos una opción con valor para Tipo de campo = Listado o Listado con selección múltiple o Listado con selección única. |
| date_value | 02-29 | Fecha anual por defecto. Formato: MM-DD. Requerido para Tipo de campo = Evento anual. Puede quedar en blanco el valor. |
Description
Permite eliminar una campo personalizado siempre que el mismo no esté siendo usado en algún segmento, formulario o automation.
Errores:
| Código | Descripción |
|---|---|
| errorMsg_customFieldNotFound | No existe campo personalizado con el ID informado. |
| errorMsg_customFieldIsUsed | No puede eliminarse el campo personalizado debido a que está siendo usado en algún segmento, formulario o automation. |
URL Variables
| Key | Value | Description |
|---|---|---|
| customfield_id | 5 | id del campo personalizado a eliminar. Requerido. |
Contactos 8
Este modulo te permitirá realizar toda la gestión asociada a contactos que luego serán utilizados en listas y/o segmentos.
Description
Devuelve una lista con todos los contactos. Pueden filtrarse por email o por lista.
Estructura de salida:
| Campo | Descripción |
|---|---|
| id | ID del contacto |
| Email del contacto | |
| created | Fecha de creación |
| lastSend | Fecha de último envío |
| suscriptions | Cantidad de listas a las que está suscripto |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_mailListNotFound | No de encontró lista con el ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| luis | Filtro por email o parte del email del contacto. | |
| listId | 2 | Filtro por lista de contactos. |
| limit | 10 | Cantidad de registros a mostrar por página. Máximo: 100. |
| page | 1 | Numero de página a mostrar. |
| orderBy | id | Criterio para ordenar los contactos. Valores posibles: email/id. Por defecto: id |
| order | asc | Tipo de ordenamiento. Valores posibles: asc/desc. Por defecto: desc. |
Description
Devuelve el detalle de un contacto.
Estructura de salida:
| Campo | Descripción |
|---|---|
| id | ID del contacto |
| Email del contacto | |
| created | Fecha de creación |
| lastActivity | Fecha última actividad |
| mailLists | Lista/s en la/s que está suscripto (ID y Nombre) |
| customFields | Campos personalizados (ID, Nombre, Tipo y Valor) |
| lastSend | Fecha de último envío |
| reads | Aperturas totales |
| clicks | Clicks totales |
| hardBounce | Rebotes duros |
| softBounce | Rebotes blandos |
| shared | Compartidos |
| unsubscription | Desuscripciones |
| complaint | Quejas |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_contactNotFound | No existe contacto con el ID informado. |
URL Variables
| Key | Value | Description |
|---|---|---|
| contact_id | 2 | Id del contacto. Requerido. |
Body
Description
Permite crear un nuevo contacto, teniendo en cuenta las siguientes consideraciones:
- Sólo es requerido ingresar el correo electrónico.
- El contacto se asignará a las listas mediante otro servicio.
- Para completar los campos personalizados se utilizará el siguiente criterio:
- Si se envía el campo con un valor, se completará con dicho valor.
- Si se envía el campo vacío, el campo se completará con valor vacío.
- Si no se envía el campo, se completará con el valor por defecto configurado (en caso de tenerlo).
Estructura de salida:
| Campo | Descripción |
|---|---|
| id | ID del contacto creado |
| Email del contacto |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_contactAlreadyExist | Ya existe un contacto con el mismo correo. |
| customsFieldsNotFound | No existe el campo personalizado indicado. |
Body
| Key | Value | Description |
|---|---|---|
| sofia@ejemplo.com | Email del contacto nuevo. Requerido. | |
| customFields[1] | Sofia | Array de campos personalizados. Debe colocarse el id del campo que se desea completar como key del array. En el caso de ser un valor de tipo fecha debe tener formato MM-DD. En el caso de un listado de opciones múltiple, separar las opciones con coma y sin espacios. Por ejemplo: opcion1,opcion3. |
Description
Permite editar un contacto, teniendo en cuenta las siguientes consideraciones:
- No es requerido ningún campo.
- El contacto se asignará a listas mediante otro servicio.
- Para editar los campos personalizados se utilizará el siguiente criterio:
- Si se envía el campo con un valor, se modifica con el valor indicado.
- Si se envía el campo vacío, se modifica con el valor indicado (blanco).
- Si no se envía el campo, no se actualiza el valor del campo quedando el valor actual.
Errores:
| Código | Descripcion |
|---|---|
| errorMsg_contactNotFound | No existe contacto con el ID informado. |
| customsFieldsNotFound | No existe el campo personalizado indicado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 6 | Id del contacto. Requerido. |
| customFields[1] | Sofía | Array de campos personalizados. Debe colocarse el id del campo que se desea completar como key del array. En el caso de ser un valor de tipo fecha debe tener formato MM-DD. En el caso de un listado de opciones múltiple, separar las opciones con coma y sin espacios. Por ejemplo: opcion1,opcion3. |
Description
Permite suscribir varios contactos a una lista, teniendo en cuenta las siguiente consideraciones:
- Los contactos que estén excluidos no podrán suscribirse. En estos casos, los mismos se mostrarán en la respuesta dentro de contactExclude y no se suscribirán.
- En caso de que algunos de los contactos indicados no existan, los mismos se mostrarán en la respuesta dentro de contactNotFound.
Errores:
| Código | Descripción |
|---|---|
| errorMsg_mailListNotFound | No existe lista de contactos con el ID informado. |
| invalidContacts | Ninguno de los contactos fue suscripto ya sea porque no existen o porque están excluídos |
Body
| Key | Value | Description |
|---|---|---|
| contactsIds[] | 4 | Array de Ids de contactos a suscribir. Requerido. Máximo: 100 registros. |
| listId | 1 | Id de la lista. Requerido. |
Description
Permite desuscribir varios contactos de una lista, teniendo en cuenta las siguiente consideraciones:
- En caso de que algunos de los contactos indicados no existan, los mismos se mostrarán en la respuesta dentro de contactNotFound.
- Los contactos que no estén suscriptos a la lista indicada, se mostrarán en la respuesta dentro de subscribeNotFound.
Errores:
| Código | Descripción |
|---|---|
| errorMsg_mailListNotFound | No existe lista de contactos con el ID informado. |
| invalidContacts | Ninguno de los contactos fue desuscripto ya sea porque no existen o porque no estaban suscriptos en la lista indicada. |
Body
| Key | Value | Description |
|---|---|---|
| contactsIds[] | 12 | Array de Ids de contactos a desuscribir. Requerido. Máximo: 100 registros. |
| listId | 1 | Id de la lista. Requerido. |
Description
Permite eliminar varios contactos, teniendo en cuenta que:
- En caso de que algunos de los contactos indicados no existan, los mismos se mostrarán en la respuesta dentro de contactsNotFound.
Errores:
| Código | Descripción |
|---|---|
| errorMsg_contactsNotFound | No existe ninguno de los contactos informados. |
Body
| Key | Value | Description |
|---|---|---|
| contactsIds[] | 49 | Array de Ids de contactos a eliminar. Requerido. |
Description
Permite cargar los contactos desde una archivo CSV.
Errores:
| Código | Descripción |
|---|---|
| errorMsg_invalidCountColumnsInParams | No coinciden la cantidad de columnas del archivo con las indicadas en los parámetros. |
| errorMsg_columnEmailNotFound | Es requerido que esté parametrizada la columna Email. |
| errorMsg_mailListNotFound | No existe lista con el ID indicado. |
Body
| Key | Value | Description |
|---|---|---|
| csv | Archivo CSV. Requerido. | |
| mailList | 6 | Id de la lista. Requerido. |
| qualifier | doubleQuote | Delimitador de campos. Requerido. Valores posibles: quote (Comilla simple) y doubleQuote (Comilla doble) |
| delimiter | comma | Separador de columnas. Requerido. Valores posibles: comma (Coma) / semicolon (Punto y coma) / numberSign (Numeral) / dollarSign (Símbolo pesos) |
| ignoreFirstRow | 1 | Ignorar la primera fila del archivo. Requerido. Valores posibles: 0 (No) y 1 (Sí). |
| columns[0] | Array indicando a que campo corresponde cada columna del archivo CSV. Valores posibles: Email (Corresponde a la columna Email) CustomFieldX (Corresponde al código del campo personalizado indicado para la columna. Ver los posibles valores en: Obtener colección de campos personalizados). Los valores de las columnas comienzan en la posición 0. Es decir que columns[0] representa la primera columna del archivo CSV. | |
| columns[1] | CustomField1 | |
| columns[2] | CustomField4 |
Cuenta 6
Este módulo agrupa servicios para gestionar la configuración de tu cuenta y conocer el resumen de tu actividad.
Description
Devuelve información de la cuenta del administrador.
Estructura de salida:
| Campo | Descripción |
|---|---|
| id | ID de la cuenta |
| name | Nombre y apellido |
| username | Nombre de usuario |
| Correo electrónico | |
| timeZone | Zona horaria. Ver los posibles valores en: Obtener zonas horarias |
| country | País. Ver los posibles valores en: Obtener países |
| subscription.Type | Tipo de plan. Valores posibles:Prepaid –> PrepagoMonthly –> Mensual |
| subscription.Quota | Cantidad de envíos del plan. Solo se muestra para Tipo de plan = Mensual |
| subscription.TermBegin | Fecha de inicio. Solo se muestra para Tipo de plan = Mensual |
| subscription.TermEnd | Fecha de fin. Solo se muestra para Tipo de plan = Mensual |
| subscription.Credits | Créditos disponibles |
| created | Fecha de creación de la cuenta |
| publicArchivesURL | Url para acceder al archivo público de campañas |
Description
Permite editar la configuración de la cuenta.
Body
| Key | Value | Description |
|---|---|---|
| name | Juan Pérez | Nombre y apellido. Requerido. |
| cuenta@ejemplo.com | Email. Requerido. | |
| timezone | -10800 | Zona Horaria. Requerido. Ver los posibles valores en: Obtener zonas horarias. |
| country | ar | Pais. Requerido. Ver los posibles valores en: Obtener países. |
Description
Devuelve estadísticas de la cuenta del administrador.
Estructura de salida:
| Campo | Descripción |
|---|---|
| TotalSent | Total de envíos del último mes |
| AvgMonthlyTotalSent | Promedio de envíos en los últimos seis meses |
| campaigns.Count | Total de campañas creadas |
| campaigns.Sent | Total de envíos en campañas |
| autoresponders.Count | Total de automation creados |
| autoresponders.Sent | Total de envíos en automations |
| maillists.Count | Cantidad de listas activas |
| activeMembers.Count | Cantidad de contactos activos |
| reads.Count | Total de aperturas en campañas y automations (aperturas totales) |
| clicks.Count | Total de clicks en campañas y automations (clicks totales) |
Description
Devuelve un listado de las posibles zonas horarias para la configuración de la cuenta.
Estructura de salida:
| Campo | Descripción |
|---|---|
| label | Descripción de la zona horaria |
| value | Código de zona horaria. Se utilizará en Editar configuración general de la cuenta |
Description
Devuelve un listado de los posibles países para la configuración de la cuenta.
Estructura de salida:
| Campo | Descripción |
|---|---|
| label | Descripción del país |
| value | Código de país. Se utilizará en Editar configuración general de la cuenta |
Description
Devuelve un listado de los dominios de la cuenta.
Estructura de salida:
| Campo | Descripción |
|---|---|
| id | ID del dominio |
| domain | Nombre del dominio |
| status | Estado del dominio. Valores posibles:NotVerified (No verificado) /Pending (Pendiente de verificación) / Verified (Verificado sin autenticar) / Authenticated (Autenticado) |
Body
| Key | Value | Description |
|---|---|---|
| name | tudominio.com | Filtro por nombre de dominio |
| status | Authenticated | Filtro por estado del dominio. Posible valores: Pending (Pendiente de verificación) / Verified (Verificado sin autenticar) / NotVerified (No verificado) / Authenticated (Autenticado). |
| limit | 10 | Cantidad de registros a mostrar por página. Máximo: 100. |
| page | 1 | Numero de página a mostrar. |
| orderBy | name | Criterio para ordenar los dominios. Valores posibles: name/id. Por defecto: id. |
| order | asc | Tipo de ordenamiento. Valores posibles: asc/desc. Por defecto: desc. |
Exclusiones 3
Este módulo te permitirá realizar toda la gestión de exclusiones de contactos para que no se les envíen tus campañas.
Description
Devuelve una lista con todas las exclusiones creadas por Usuario. Pueden filtrarse por email.
Body
| Key | Value | Description |
|---|---|---|
| correo@ejemplo.com | Filtro por email. | |
| limit | 5 | Cantidad de registros a mostrar por página. Máximo: 100. |
| page | 1 | Numero de página a mostrar. |
| orderBy | Criterio para ordenar las exclusiones. Valores posibles: email/id. Por defecto: id. | |
| order | asc | Tipo de ordenamiento. Valores posibles: asc/desc. Por defecto: desc. |
Description
Permite crear exclusiones, teniendo en cuenta que:
- En caso de que algunas de las listas indicadas no existan, las mismas se mostrarán en la respuesta dentro de listsNotFound.
Errores:
| Código | Descripción |
|---|---|
| msg_listsNotFounds | No existe ninguna de las listas informadas. |
Body
| Key | Value | Description |
|---|---|---|
| always | 0 | Tipo de exclusión. Valores posibles : 0 (sobre listas seleccionadas) / 1 (sobre todas las listas y futuras). |
| emails[] | exclusion@ejemplo.com | Array de Ids de contactos a excluir. Requerido. Máximo: 100 registros. |
| listIds[] | 1 | Array de Ids de listas. Requerido para Tipo de exclusión = Sobre listas seccionadas. Máximo: 100 registros. |
Description
Permite eliminar una exclusión creada por Usuario.
Errores:
| Código | Descripción |
|---|---|
| errorMsg_exclusionNotFound | No existe exclusión con el ID informado. |
URL Variables
| Key | Value | Description |
|---|---|---|
| exclusion_id | 3 | Id de exlcusión a eliminar. Requerido. |
Body
Formularios 2
Este módulo te permitirá realizar toda la gestión asociada a formularios para que los contactos puedan suscribirse a tus listas.
Description
Devuelve una lista de todos los formularios. Pueden filtrarse por nombre.
Estructura de salida:
| Campo | Descripción |
|---|---|
| id | ID del formulario |
| name | Nombre del formulario |
Body
| Key | Value | Description |
|---|---|---|
| name | prueba | Filtro por nombre o parte del nombre del formulario. |
| limit | 10 | Cantidad de registros a mostrar por página. Máximo: 100. |
| page | 1 | Numero de página a mostrar. |
| orderBy | name | Criterio para ordenar los formularios. Valores posibles: nombre/id. Por defecto: id. |
| order | asc | Tipo de ordenamiento. Valores posibles: asc/desc. Por defecto: desc. |
Description
Devuelve el detalle de un formulario.
Estructura de salida:
| Campo | Descripción |
|---|---|
| id | ID del formulario |
| name | Nombre del formulario |
| mailLists | Lista/s de contacto/s (ID y Nombre) |
| urlSubsOK | URL de suscripción satisfactoria |
| urlSubsError | URL de suscripción errónea |
| notificationEmail | Correo para recibir notificación ante la suscripción de un contacto |
| emailConfirm.subject | Asunto del correo de confirmación |
| emailConfirm.fromName | Remitente del correo de confirmación |
| emailConfirm.fromEmail | Email “desde” del correo de confirmación |
| emailConfirm.replyToEmail | Email “para responder” del correo de confirmación |
| urlConfirmOK | URL confirmación de suscripción satisfactoria |
| urlConfirmError | URL confirmación de suscripción errónea |
| scriptFormWebSite | Código para tu sitio web |
| urlFormWebSite | Enlace para redes sociales |
| codeQR | Código QR |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_formNotFound | No existe formulario con el ID informado. |
URL Variables
| Key | Value | Description |
|---|---|---|
| form_id | 1 | Id del formulario. Requerido. |
Listas de contactos 6
Este módulo agrupa servicios para la gestión de las listas de contactos que podrán ser utilizadas en tus campañas.
Description
Devuelve una lista de todas las listas de contactos. Pueden filtrarse por nombre.
Estructura de salida:
| Campo | Descripción |
|---|---|
| id | ID de la lista |
| name | Nombre de la lista |
| count | Cantidad de contactos |
| lastSend | Fecha de último envío |
Body
| Key | Value | Description |
|---|---|---|
| name | nombre | Filtro por nombre o parte del nombre de lista. |
| limit | 10 | Cantidad de registros a mostrar por página. Máximo: 100. |
| page | 1 | Numero de página a mostrar. |
| orderBy | id | Criterio para ordenar las listas. Valores posibles: name/id. Por defecto: id. |
| order | desc | Tipo de ordenamiento. Valores posibles: asc/desc. Por defecto: desc. |
Description
Permite crear una nueva lista.
Estructura de salida:
| Campo | Descripción |
|---|---|
| id | ID de la lista creada |
| name | Nombre de la lista |
Body
| Key | Value | Description |
|---|---|---|
| name | Lista nueva | Nombre de la lista. Requerido. No se permiten caracteres especiales. |
Description
Permite editar una lista.
Errores:
| Código | Descripción |
|---|---|
| errorMsg_contactListNotFound | No existe lista con el ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 1 | Id de la lista. Requerido. |
| name | Lista de prueba | Nombre de la lista. Requerido. No se permiten caracteres especiales. |
Description
Permite eliminar una lista.
Errores:
| Código | Descripción |
|---|---|
| errorMsg_listContactNotFound | No existe lista con el ID informado. |
URL Variables
| Key | Value | Description |
|---|---|---|
| list_id | 10 | Id de lista a eliminar. Requerido. |
Description
Permite eliminar varias listas de contactos a la vez, teniendo en cuenta que:
- En caso de que algunas de las listas indicadas no existan, las mismas se mostrarán en la respuesta dentro de mailListsNotFound.
Errores:
| Código | Descripción |
|---|---|
| invalid_max_elements | Como máximo pueden eliminarse hasta 100 registros. |
Body
| Key | Value | Description |
|---|---|---|
| ids[] | 6 | Array de Ids de listas a eliminar. Requerido. Como máximo 100. |
Plantillas 1
Este módulo te permitirá obtener el detalle de tu plantillas, para luego utilizarlas para crear el contenido de tus campañas/automations.
Description
Devuelve una lista de todas las plantillas. Pueden filtrarse por etiquetas.
Estructura de salida:
| Campo | Descripción |
|---|---|
| id | ID de la plantilla |
| tags | Etiquetas |
| created | Fecha de creación de la plantilla |
| thumbUrl | Url thumbnail |
Body
| Key | Value | Description |
|---|---|---|
| tags[] | Valentín | Array de etiquetas |
| tags[] | Carnaval | Array de etiquetas |
| limit | 10 | Cantidad de registros a mostrar por página. Máximo: 100. |
| page | 1 | Numero de página a mostrar. |
| orderBy | id | Criterio para ordenar las plantillas. Valores posibles: creation/id. Por defecto: creation. |
| order | asc | Tipo de ordenamiento. Valores posibles: asc/desc. Por defecto: desc. |
Reportes de campañas/automation 10
Este módulo te permitirá conocer el reporte y las estadísticas de cada campaña/automation enviada.
Description
Devuelve el reporte general de una campaña/automation.
Estructura de salida:
| Campo | Descripción |
|---|---|
| campaign.name | Nombre de la campaña/automation. |
| campaign.sendDate | Fecha y hora de envío. Sólo para campañas. |
| publicURL | Url reporte público |
| delivery.total | Total de contactos.Para Camapañas: Es la suma de todos los contactos incluidos dentro de las listas o segmentos a los que se envió la campaña.Para automation: Es la suma de todos los contactos que cumplieron el evento. |
| delivery.exclusions.duplicated.Amount | Contactos repetidos |
| delivery.exclusions.duplicated.Percentage | Porcentaje de contactos repetidos sobre el total de contactos excluidos del envío |
| delivery.exclusions.banned.Amount | Contactos en lista de exclusión |
| delivery.exclusions.banned.Percentage | Porcentaje de contactos en lista de exclusión sobre el total de contactos excluidos del envío |
| delivery.exclusions.total | Contactos excluidos del envío (Contactos repetidos + Contactos en lista de exclusión) |
| delivery.exclusions.totalPercentage | Porcentaje de contactos excluídos sobre el total de contactos |
| delivery.bounces.hard.Amount | Rebotes duros |
| delivery.bounces.hard.Percentage | Porcentaje de rebotes duros sobre el total de rebotes |
| delivery.bounces.soft.Amount | Rebotes blandos |
| delivery.bounces.soft.Percentage | Porcentaje de rebotes blandos sobre el total de rebotes |
| delivery.bounces.total | Total de rebotes. Son los mails que no pudieron entregarse porque los servidores de los correos de destino los rechazaron |
| delivery.bounces.totalPercentage | Porcentaje de rebotes sobre el total de contactos |
| delivery.pending | Total de pendientes. Son las direcciones de correo a las que el sistema aún no ha enviado el mail |
| delivery.pendingPercentage | Porcentaje de pendientes sobre el total de contactos |
| delivery.delivered | Total entregados. Comprende el total de mails que llegaron a destino |
| delivery.deliveredPercentage | Porcentaje de entregados sobre el total de contactos |
| performance.reads | Cantidad de veces que fue abierta la campaña/automation |
| performance.uniqueReads | Cantidad de contactos que abrieron la campaña/automation |
| performance.readsPercentage | Porcentaje de contactos que abrieron la campaña/automation sobre el total entregado |
| performance.clicks | Cantidad de clicks que se hicieron en la campaña/automation |
| performance.uniqueClicks | Cantidad de contactos que hicieron click en la campaña /automation |
| performance.clicksPercentage | Porcentaje de contactos que hicieron click en la campaña/automation sobre el total entregado |
| performance.shared.total | Total de compartidos |
| performance.shared.forwardto.Amount | Total de compartidos por correo |
| performance.shared.forwardto.Percentage | Porcentaje de compartidos por correo |
| performance.shared.facebook.Amount | Total de compartidos por Facebook |
| performance.shared.facebook.Percentage | Porcentaje de compartidos por Facebook |
| performance.shared.linkedin.Amount | Total de compartidos por LinkedIn |
| performance.shared.linkedin.Percentage | Porcentaje de compartidos por LinkedIn |
| performance.shared.twitter.Amount | Total de compartidos por Twitter |
| performance.shared.twitter.Percentage | Porcentaje de compartidos por Twitter |
| performance.shared.pinterest.Amount | Total de compartidos por Pinterest |
| performance.shared.pinterest.Percentage | Porcentaje de compartidos por Pinterest |
| performance.shared.whatsapp.Amount | Total de compartidos por Whatsapp |
| performance.shared. whatsapp.Percentage | Porcentaje de compartidos por Whatsapp |
| performance.unsubscriptions.total | Total de desuscripciones |
| performance.unsubscriptions.alreadyUnsubscribed.Amount | Total de desuscriptos con motivo Ya me desuscribi |
| performance.unsubscriptions.alreadyUnsubscribed.Percentage | Porcentaje de desuscriptos con motivo Ya me desuscribi |
| performance.unsubscriptions.irrelevant.Amount | Total de desuscriptos con motivo Contenidos irrelevantes |
| performance.unsubscriptions.irrelevant.Percentage | Porcentaje de desuscriptos por Contenidos irrelevantes |
| performance.unsubscriptions.neverSignUp.Amount | Total de desuscriptos con motivo Nunca me suscribi |
| performance.unsubscriptions.neverSignUp.Percentage | Porcentaje de desuscriptos con motivo Nunca me suscribi |
| performance.unsubscriptions.spam.Amount | Total de desuscriptos con motivo Lo considero SPAM |
| performance.unsubscriptions.spam.Percentage | Porcentaje de desuscriptos con motivo Lo considero SPAM |
| performance.unsubscriptions.tooOften.Amount | Total de desuscriptos con motivo Demasiada frecuencia |
| performance.unsubscriptions.tooOften.Percentage | Porcentaje de desuscriptos con motivo Demasiada frecuencia |
| performance.unsubscriptions.other.Amount | Total de desuscriptos con otros motivos |
| performance.unsubscriptions.other.Percentage | Porcentaje de desuscriptos con otros motivos |
| performance.complaints | Cantidad de quejas. Es el número de destinatarios que marcaron la campaña/automation como spam |
| devices.mobileTotal | Total de aperturas en Móviles |
| devices.mobilePercentage | Porcentaje de aperturas en Móviles |
| devices.mobileAgents | Detalle de aperturas en Móviles (Cantidad por agente y Porcentaje) |
| devices.desktopTotal | Total de aperturas en Escritorio |
| devices.desktopPercentage | Porcentaje de aperturas en Escritorio |
| devices.desktopAgents | Detalle de aperturas en Escritorio (Cantidad por agente y Porcentaje) |
| devices.tabletTotal | Total de aperturas en Tablets |
| devices.tabletPercentage | Porcentaje de aperturas en Tablets |
| devices.tabletAgents | Detalle de aperturas en Tablets (Cantidad por agente y Porcentaje) |
| devices.unknownTotal | Total de aperturas en Dispositvos desconocidos |
| devices.unknownPercentage | Porcentaje de aperturas en Dispositvos desconocidos |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_campaignNotFound | No existe campaña/automation con el ID informado. |
URL Variables
| Key | Value | Description |
|---|---|---|
| campaign_id | 100 | Id de campaña/automation. Requerido. |
Description
Devuelve el detalle de las aperturas de la campaña/automation.
Estructura de salida:
| Campo | Descripción |
|---|---|
| Email del contacto que realizó la apertura | |
| date | Fecha y hora de la apertura |
| countryCode | País donde se abrió la campaña/automation (Código ISO) |
| city | Cuidad donde se abrió la campaña/automation (Descripción) |
| platform | Dispositivo donde se abrió la campaña/automation |
| latitude | Coordenada geográfica donde se abrió la campaña/automation (latitud) |
| longitude | Coordenada geográfica donde se abrió la campaña/automation (longitud) |
| app | Aplicación donde se abrió la campaña/automation |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_campaignNotFound | No existe campaña/automation con el ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 386 | Id de campaña/automation. Requerido. |
| limit | 10 | Cantidad de registros a mostrar por página. Máximo: 100. |
| page | 1 | Numero de página a mostrar. |
| order | asc | Ordenar por fecha. Valores posibles: asc/desc. Por defecto: desc. |
Description
Devuelve el detalle de los clicks realizados en la campaña/automation.
Estructura de salida:
| Campo | Descripción |
|---|---|
| date | Fecha y hora del click |
| url | Url donde se hizó click |
| Email del contacto que realizó el click |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_campaignNotFound | No existe campaña/automation con el ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 386 | Id de campaña/automation. Requerido. |
| limit | 10 | Cantidad de registros a mostrar por página. Máximo: 100. |
| page | 1 | Numero de página a mostrar. |
| order | asc | Ordenar por fecha. Valores posibles: asc/desc. Por defecto: desc. |
Description
Devuelve el detalle de los compartidos de la campaña/automation.
Estructura de salida:
| Campo | Descripción |
|---|---|
| date | Fecha y hora que se compartió la campaña/automation |
| via | Medio donde se compartió la campaña/automation. Valores posibles:forwardto -> Correofacebook -> Facebooktwitter -> Twitterlinkedin -> LinkedInpinterest -> Pinterestwhatsapp -> WhatsApp |
| Email del contacto que compartió la campaña/automation |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_campaignNotFound | No existe campaña/automation con el ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 386 | Id de campaña/automation. Requerido. |
| limit | 10 | Cantidad de registros a mostrar por página. Máximo: 100. |
| page | 1 | Numero de página a mostrar. |
| order | asc | Ordenar por fecha. Valores posibles: asc/desc. Por defecto: desc. |
Description
Devuelve el detalle de los rebotes (duros y blandos) que se registraron para la campaña/automation.
Estructura de salida:
| Campo | Descripción |
|---|---|
| date | Fecha y hora del rebote |
| type | Tipo de rebote. Valores posibles:soft -> Rebote blandohard -> Rebote duro |
| Email del contacto que rebotó |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_campaignNotFound | No existe campaña/automation con el ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 386 | Id de campaña/automation. Requerido. |
| limit | 10 | Cantidad de registros a mostrar por página. Máximo: 100. |
| page | 1 | Numero de página a mostrar. |
| order | asc | Ordenar por fecha. Valores posibles: asc/desc. Por defecto: desc. |
| type | hard | Filtro por tipo de rebote. Valores posibles: soft/hard. |
Description
Devuelve el detalle de desuscripciones realizadas en la campaña/automation.
Estructura de salida:
| Campo | Descripción |
|---|---|
| date | Fecha y hora de la desuscripción |
| reason | Razón de la desuscripción. Valores posibles:irrelevant -> Contenidos irrelevantestooOften -> Demasiada frecuencianeverSignUp -> Nunca me suscribíalreadyUnsubscribed -> Ya me desuscribíspam -> Lo considero SPAMother -> Otros |
| note | Notas adicionales cuando selecciona motivo = Otros |
| Email del contacto que se desuscribió |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_campaignNotFound | No existe campaña/automation con el ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 386 | Id de campaña/automation. Requerido. |
| limit | 10 | Cantidad de registros a mostrar por página. Máximo: 100. |
| page | 1 | Numero de página a mostrar. |
| order | asc | Ordenar por fecha. Valores posibles: asc/desc. Por defecto: desc. |
Description
Devuelve el detalle de quejas realizadas en la campaña/automation.
Estructura de salida:
| Campo | Descripción |
|---|---|
| date | Fecha y hora de la queja |
| Email del contacto que realizó la queja |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_campaignNotFound | No existe campaña/automation con el ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 386 | Id de campaña/automation. Requerido. |
| limit | 10 | Cantidad de registros a mostrar por página. Máximo: 100. |
| page | 1 | Numero de página a mostrar. |
| order | asc | Ordenar por fecha. Valores posibles: asc/desc. Por defecto: desc. |
Description
Devuelve el detalle de contactos excluidos ya sea por duplicado o por estar en lista de exclusión. Tener en cuenta que estos últimos sólo se registraban en las versiones anteriores; ahora no se registran más.
Estructura de salida:
| Campo | Descripción |
|---|---|
| Email del contacto excluido | |
| reason | Razón de la exclusión. Valores posibles:duplicated -> Duplicadobanned -> En lista de exclusión |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_campaignNotFound | No existe campaña/automation con el ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 386 | Id de campaña/automation. Requerido. |
| limit | 10 | Cantidad de registros a mostrar por página. Máximo: 100. |
| page | 1 | Numero de página a mostrar. |
| order | asc | Ordenar por email. Valores posibles: asc/desc. Por defecto: desc. |
Description
Devuelve un archivo con el detalle de los contactos a los que se envió la campaña/automation.
Importante: Esta información solo estará disponible 6 meses desde el envío de la campaña/automation, pasado ese tiempo no podrá descargarse más.
Estructura de salida:
Se generará un archivo sents.txt conteniendo en cada línea: fecha de envío, hora de envío y email del contacto al que se envió la campaña/automation.
Errores:
| Código | Descripción |
|---|---|
| errorMsg_campaignNotFound | No existe campaña/automation con el ID informado |
| errorMsg_campaignStatisticsNotFound | La campaña/automation todavía no fue enviada |
| errorMsg_campaignSentsNotFound | El archivo ya no está disponible por haber pasado más de 6 meses desde el envío de la campaña/automation |
Body
| Key | Value | Description |
|---|---|---|
| id | 352 | Id de campaña/automation. Requerido. |
Description
Devuelve un archivo con el detalle de los contactos duplicados.
Importante: Esta información solo estará disponible 6 meses desde el envío de la campaña/automation, pasado ese tiempo no podrá descargarse más.
Estructura de salida:
Se generará un archivo duplicates.csv conteniendo dos datos: email del contacto repetido y cantidad de repeticiones.
Errores:
| Código | Descripción |
|---|---|
| errorMsg_campaignNotFound | No existe campaña/automation con el ID informado |
| errorMsg_campaignStatisticsNotFound | La campaña/automation todavía no fue enviada |
| errorMsg_campaignDuplicatesNotFound | El archivo ya no está disponible por haber pasado más de 6 meses desde el envío de la campaña/automation |
Body
| Key | Value | Description |
|---|---|---|
| id | 9 | Id de campaña/automation. Requerido. |
Reportes de contactos 6
Este módulo te permitirá conocer el detalle de la actividad del contacto.
Description
Devuelve el detalle de las aperturas de campañas realizadas por el contacto.
Estructura de salida:
| Campo | Descripción |
|---|---|
| date | Fecha y hora de la apertura |
| countryCode | País desde el que se abrió |
| platform | Dispositvo desde el que se abrió |
| campaignName | Nombre de la campaña |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_contactNotFound | No existe contacto con el ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 2 | Id del contacto. Requerido. |
| limit | 10 | Cantidad de registros a mostrar por página. Máximo: 100. |
| page | 1 | Numero de página a mostrar. |
| order | asc | Ordenar por fecha. Valores posibles: asc/desc. Por defecto: desc. |
Description
Devuelve el detalle de los clicks realizados por el contacto.
Estructura de salida:
| Campo | Descripción |
|---|---|
| date | Fecha y hora del click |
| url | URL donde hizo click |
| campaignName | Nombre de la campaña |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_contactNotFound | No existe contacto con el ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 2 | Id del contacto. Requerido. |
| limit | 10 | Cantidad de registros a mostrar por página. Máximo: 100. |
| page | 1 | Numero de página a mostrar. |
| order | asc | Ordenar por fecha. Valores posibles: asc/desc. Por defecto: desc. |
Description
Devuelve el detalle de las campañas compartidas por el contacto.
Estructura de salida:
| Campo | Descripción |
|---|---|
| date | Fecha y hora que compartió la campaña |
| via | Medio donde se compartió la campaña. Valores posibles:forwardto -> Correofacebook -> Facebooktwitter -> Twitterlinkedin -> LinkedInpinterest -> Pinterestwhatsapp -> WhatsApp |
| campaignName | Nombre de la campaña |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_contactNotFound | No existe contacto con el ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 2 | Id del contacto. Requerido. |
| limit | 10 | Cantidad de registros a mostrar por página. Máximo: 100. |
| page | 1 | Numero de página a mostrar. |
| order | asc | Ordenar por fecha. Valores posibles: asc/desc. Por defecto: desc. |
Description
Devuelve el detalle de los rebotes (duros y blandos) que se registraron para el contacto.
Estructura de salida:
| Campo | Descripción |
|---|---|
| date | Fecha y hora del rebote |
| type | Tipo de rebote. Valores posibles:soft -> Rebote blandohard -> Rebote duro |
| campaignName | Nombre de la campaña |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_contactNotFound | No existe contacto con el ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 2 | Id del contacto. Requerido. |
| limit | 10 | Cantidad de registros a mostrar por página. Máximo: 100. |
| page | 1 | Numero de página a mostrar. |
| order | asc | Ordenar por fecha. Valores posibles: asc/desc. Por defecto: desc. |
| type | hard | Filtro por tipo de rebote. Valores posibles: soft/hard. |
Description
Devuelve el detalle de las desuscripciones realizadas por el contacto desde las campañas.
Estructura de salida:
| Campo | Descripción |
|---|---|
| date | Fecha y hora de la desuscripción |
| reason | Razón de la desuscripción. Valores posibles:irrelevant -> Contenidos irrelevantestooOften -> Demasiada frecuencianeverSignUp -> Nunca me suscribíalreadyUnsubscribed -> Ya me desuscribíspam -> Lo considero SPAMother -> Otros |
| campaignName | Nombre de la campaña |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_contactNotFound | No existe contacto con el ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 2 | Id del contacto. Requerido. |
| limit | 10 | Cantidad de registros a mostrar por página. Máximo: 100. |
| page | 1 | Numero de página a mostrar. |
| order | asc | Ordenar por fecha. Valores posibles: asc/desc. Por defecto: desc. |
Description
Devuelve el detalle de las quejas realizadas por el contacto desde las campañas.
Estructura de salida:
| Campo | Descripción |
|---|---|
| date | Fecha y hora de la queja |
| campaignName | Nombre de la campaña |
Errores:
| Código | Descripción |
|---|---|
| errorMsg_contactNotFound | No existe contacto con el ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 2 | Id del contacto. Requerido. |
| limit | 10 | Cantidad de registros a mostrar por página. Máximo: 100. |
| page | 1 | Numero de página a mostrar. |
| order | asc | Ordenar por fecha. Valores posibles: asc/desc. Por defecto: desc. |
Segmentos 1
Este módulo permite obtener un detalle de los segmentos que podrán ser utilizados en tus campañas.
Description
Devuelve una lista de todas los segmentos. Pueden filtrarse por nombre.
Estructura de salida:
| Campo | Descripción |
|---|---|
| id | ID del segmento |
| name | Nombre del segmento |
| created | Fecha de creación |
| members | Cantidad de contactos |
| lastSend | Fecha de último envío |
Body
| Key | Value | Description |
|---|---|---|
| name | nombre | Filtro por nombre o parte del nombre del segmento. |
| limit | 10 | Cantidad de registros a mostrar por página. Máximo: 100. |
| page | 1 | Numero de página a mostrar. |
| orderBy | id | Criterio para ordenar los segmentos. Valores posibles: nombre/id. Por defecto: id. |
| order | asc | Tipo de ordenamiento. Valores posibles: asc/desc. Por defecto: desc. |
Tareas 1
Este módulo te permitirá obtener el detalle de las tareas generadas desde la herramienta.
Description
Devuelve una lista de las tareas realizadas. Pueden filtrarse por estado.
Estructura de salida:
| Campo | Descripción |
|---|---|
| id | ID de la tarea |
| date | Fecha y hora de la tarea |
| type | Tarea realizada. Valores posibles:excludeContacts -> Cargar exclusionescontactsCopied -> Gestion de contactos>CopiarcontactsMoved -> Gestión de contactos>MovercontactsExported -> Gestión de contactos>ExportarcontactsUnsubscribed -> Gestión de contactos>DesuscribircontactsDeleted -> Gestión de contactos>EliminarimportContacts -> Importación de contactossegmentUpdated -> Actualización de segmentoreportSummary -> Reportes de campañas>Reporte resumenreportReads -> Reportes de campañas>AperturasreportClicks -> Reportes de campañas>ClicksreportPerformance -> Reportes de campañas>RendimientoreportDelivery -> Reportes de campañas>EntregadosreportShareds -> Reportes de campañas>CompartidosreportUnsubscriptions -> Reportes de campañas>DesuscripcionesreportExclusions -> Reportes de campañas>ExclusionesreportBounces -> Reportes de campañas>RebotesreportComplaints -> Reportes de campañas>QuejasreportSent -> Reportes de campañas>EnviadosreportBans -> Exportar exclusionesreportSummaryMulti -> Seleccionar varios Reportes>Exportar reportesdownloadGDPR -> Exportar datos de la cuentaexportSegment -> Segmentos>ExportarexportList -> Listas>Exportar |
| details.total | Total de procesados. Este campo sólo se muestra para las tareas que realizan procesamientos sobre registros. |
| details.imported | Total de contactos importados. Este campo sólo se muestra para la tarea importContacts. |
| details.notImported | Total de contactos NO importados. Este campo sólo se muestra para la tarea importContacts. |
| details.sourceImport | Tipo de importación. Este campo sólo se muestra para la tarea importContacts. Valores posibles:copypaste -> Desde Copiar y pegar.csv -> Desde archivo CSVGmail -> Desde GmailOutlook -> Desde Outlook |
| details.moved | Total de contactos movidos. Este campo sólo se muestra para la tarea contactsMoved. |
| details.notMoved | Total de contactos NO movidos. Este campo sólo se muestra para la tarea contactsMoved. |
| details.copied | Total de contactos copiados. Este campo sólo se muestra para la tarea contactsCopied. |
| details.notCopied | Total de contactos NO copiados. Este campo sólo se muestra para la tarea contactsCopied. |
| details.campaingName | Nombre de la campaña de referencia. Este campo sólo se muestra para las tareas correspondientes a Reportes de campañas. |
| details.name | Nombre del segmento o lista. Este campo sólo se muestra para las tareas realizadas sobre segmentos o listas. |
| details.contacts | Cantidad de contactos. Este campo sólo se muestra para la tarea segmentUpdated. |
| downloadLink | Enlace para descargar el archivo. Para poder descargarlo será requerido autenticarse de la misma manera que en el resto de los servicios. OBS: Las tareas downloadGDPR y segmentUpdated son las únicas tareas que NO generan archivos. |
| status | Estado de la tarea. Valores posibles:completed -> Finalizadapending -> En proceso |
Body
| Key | Value | Description |
|---|---|---|
| status | completed | Filtro por estado de la tarea. Valores posibles: completed (Finalizadas) y pending (En proceso). |