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: https://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.

Ver en Postman

Seteo de variables

Nuestra colección de métodos necesita de la parametrización de las siguientes variables de Postman para su correcto funcionamiento:

NombreValor
urlhttps​://api.esmsv.com
tokenI6Ik9UZzFNakUyTVRVME9USXpNVGM0TUE9PSIsIntyuHVlIjoiMm9y…

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.

NombreDescripción
statusAquí saldrá valor “ok” cuando el proceso se ejecute correctamente y “error” cuando exista algún error.
codeAquí 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ódigoDescripción
is_not_acceptedValor no aceptado.
invalid_urlURL inválida.
invalid_dateFecha incorrecta.
invalid_alpha_formatEl valor sólo debe contener letras.
invalid_alpha_dash_formatEl valor sólo debe contener letras, números, guiones y guiones bajos.
invalid_alpha_num_formatEl valor sólo debe contener letras y números.
invalid_array_formatEl Valor debe ser un array.
attachedEste campo ya se adjuntó.
before_dateEl valor debe ser una fecha anterior.
before_or_equal_dateEl valor debe ser una fecha anterior o igual.
invalid_between_elementsCantidad de elementos inválido.
invalid_between_size_fileTamaño de archivo inválido.
invalid_between_numberValor inválido.
invalid_between_charactersCantidad de caracteres inválido.
invalid_booleanEl valor debe ser true o false.
invalid_value_confirmedValor confirmado inválido.
invalid_date_formatFormato de fecha inválido.
invalid_date_equalFecha incorrecta.
invalid_value_differentEl valor debe ser diferente.
invalid_value_digitsCantidad de digitos inválido.
invalid_value_digits_betweenCantidad de digitos inválido.
invalid_image_dimensionsDimensiones de imagen inválidas.
value_duplicateValor duplicado.
invalid_email_formatEl formato del email es incorrecto.
invalid_velue_ends_withEl valor ingresado es incorrecto.
not_existsEl campo es inválido.
is_not_fileEl campo debe ser un archivo.
not_emptyEl campo es obligatorio.
invalid_gt_elementsCantidad de elementos inválido.
invalid_gt_size_fileTamaño de archivo inválido.
invalid_gt_numericValor incorrecto.
invalid_gt_charactersCantidad de caracteres inválido.
invalid_gte_elementsCantidad de elementos inválido.
invalid_gte_size_fileTamaño del archivo inválido.
invalid_gte_numericValor inválido.
invalid_gte_charactersCantidad de caracteres inválido.
invalid_imageEl campo debe ser una imagen.
invalid_value_inValor inválido.
invalid_value_in_arrayValor inválido.
invalid_value_integerEl campo debe ser un número entero.
invalid_value_ipEl campo debe ser una dirección IP válida.
invalid_ipv4_formatEl campo debe ser una dirección IPv4 válida.
invalid_ipv6_formatEl campo debe ser una dirección IPv6 válida.
invalid_json_formatEl campo El campo debe ser una cadena JSON válida.
invalid_lt_elementsCantidad de elementos inválido.
invalid_lt_size_fileTamaño del archivo inválido.
invalid_lt_numericValor inválido.
invalid_lt_charactersCantidad de caracteres inválida.
invalid_lte_elementsCantidad de elementos inválido.
invalid_lte_size_fileTamaño del archivo inválido.
invalid_lte_numericValor inválido.
invalid_lte_charactersCantidad de caracteres inválido.
invalid_max_elementsCantidad de elementos inválido.
invalid_max_size_fileTamaño del archivo inválido.
invalid_max_numericValor inválido.
invalid_max_charactersCantidad de caracteres inválido.
invalid_mimesFormato de archivo inválido.
invalid_mimetypesFormato de archivo inválido.
invalid_min_elementsCantidad de elementos inválido.
invalid_min_size_fileTamaño de archivo inválido.
invalid_min_numericValor inválido.
invalid_min_charactersCantidad de caracteres inválido.
multiple_ofValor inválido.
invalid_formatFormato de campo inválido.
only_numericEl campo debe ser numérico.
invalid_passwordContraseña es incorrecta.
is_not_presentEl campo debe estar presente.
prohibitedEl campo está prohibido.
prohibited_ifEl campo está prohibido.
prohibited_unlessEl campo está prohibido.
relatableEl campo no se puede asociar con este recurso.
requiredEl campo es obligatorio.
is_not_same_thatEl campo deben coincidir.
invalid_count_elementsCantidad de elementos inválido.
invalid_size_fileTamaño de archivo inválido.
invalid_size_numberValor inválido.
invalid_count_charactersCantidad de caracteres inválido.
invalid_valueValor inválido.
only_charactersEl campo debe ser una cadena de caracteres.
invalid_timezoneEl campo debe ser una zona válida.
is_usedEl campo ya ha sido registrado.
error_upload_fileError al subir el archivo.
invalid_url_formatEl formato tipo url del campo es inválido.
invalid_uuid_formatEl 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:

CampoDescripción
idID del automation
nameTítulo del automation
createdFecha de creación del automation
schedule_typeTipo de envío. Valores posibles:AutoresponderInmediate -> Apenas se detecte el eventoAutoresponderDeferred-> Programada
days_of_the_weekDías de la semana que puede enviarse
momentMomento que se enviará el automation. Valores posibles:after -> Despues debefore -> Antes deonDay -> En el díaSolo se muestra si Tipo de envío = Programado
daysCantidad de días. Solo se muestra si Tipo de envío = Programado y Momento = Antes de o Después de.
hourHora de envío. Solo se muestra si Tipo de envío = Programado
eventEvento disparador. Ver los posibles valores en: Obtener eventos disparadores de automation.
statusEstado del automation. Valores posibles:Draft -> BorradorPaused -> PausadoStopped -> DetenidoPendingforApproval -> Pendiente de aprobaciónSending -> Activo
Body
KeyValueDescription
filterprueba

Filtro por nombre o parte del nombre del automation.

statusSending

Filtro por estado del automation. Posible valores: Draft (Borrador) / Sending (Activo) / Paused (Pausado) / PendingForApproval (Pendiente de aprobación) / Stopped (Detenido)

createDateFrom2023-04-23

Filtro por fecha de creación desde. Formato: YYYY-MM-DD.

createDateTo2023-05-28

Filtro por fecha de creación hasta. Formato: YYYY-MM-DD.

limit10

Cantidad de registros a mostrar por página. Máximo: 100.

page1

Numero de página a mostrar.

orderByname

Criterio para ordenar los automations. Valores posibles: name/id. Por defecto: id.

orderdesc

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:

CampoDescripcion
idID del automation
nameTítulo del automation
subjectAsunto
previewTextTexto de vista previa
fromAliasNombre del remitente
fromEmailDesde
replyEmailResponder a
eventEvento disparador. Ver los posibles valores en: Obtener eventos disparadores de automation.
maillistsLista/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
idCustomFieldCódigo de campo personalizado tipo Evento anual configurado. Sólo se muestra para Evento disparador = Evento anual
relCampaignId 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
urlUrl de la campaña asociada al automation. Sólo se muestra para Eventos = Clic en link específico y Sin clics en un link
daysNoClickCantidad de días sin clic. Sólo se muestra para Evento = Sin clics en un link
createdFecha de creación del automation
schedule_typeTipo de envío. Valores posibles:AutoresponderInmediate -> Apenas se detecte el eventoAutoresponderDeferred-> Programada
momentMomento que se enviará el automation. Valores posibles:after -> Despues debefore -> Antes deonDay -> En el díaSolo se muestra si Tipo de envío = Programado
daysCantidad de días. Solo se muestra si Tipo de envío = Programado y Momento = Antes de o Después de.
hourHora de envío. Solo se muestra si Tipo de envío = Programado
daysOfTheWeekDías de la semana que puede enviarse
statusEstado del automation. Valores posibles:Draft -> BorradorPaused -> PausadoStopped -> DetenidoPendingforApproval -> Pendiente de aprobaciónSending -> Activo
contentContenido del automation en HTML
trackLinkClicksSeguir enlaces
trackReadsContar aperturas
trackAnaliticsVincular con Google Analytics

Errores:

CódigoDescripcion
errorMsg_automationNotFoundNo existe automation con el ID informado.
URL Variables
KeyValueDescription
automation_id449

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:

CampoDescripción
idID del automation creado
nameTítulo del automation

Errores:

CódigoDescripción
errorMsg_relCampaignNotActiveLa campaña de referencia está en borrador.
errorMsg_relCampaignNotFoundNo existe campaña con el ID informado.
errorMsg_relCampaignRequiredEs requerido informar la Campaña de referencia cuando se informa un Link.
errorMsg_mailListsIdsNotValidNo existe lista con el ID informado.
errorMsg_specificUrlInvalidNo existe el link informado.
errorMsg_idCFNotFoundNo existe campo personalizado Tipo = Evento anual con el ID informado.
errorMsg_relCampaignIsNotAllowedByEventNo está permitido informar Campaña de referencia para el Evento informado.
errorMsg_specificUrlIsNotAllowedByEventNo está permitido informar Link específico para el Evento informado.
errorMsg_idCFIsNotAllowedByEventNo está permitido informar Fecha específica para el Evento informado.
errorMsg_mailListsIdsIsNotAllowedByEventNo está permitido informar Listas de contactos para el Evento informado.
errorMsg_daysNoClickIsNotAllowedByEventNo está permitido informar Días sin clic para el Evento informado.
errorMsg_contentOrContentUrlSólo es posible ingresar uno de los campos: Contenido HTML o Url.
Body
KeyValueDescription
namePromoción dia del padre

Título del automation. Requerido.

subjectHola %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”.

previewTextTexto para la vista previa

Texto de vista previa.

fromAliasEmpresa S.A.

Nombre del remitente.

fromEmailadministrador@ejemplo.com

Dirección de email desde la cuál saldrá el automation. Requerido solo si se completa el campo “fromAlias”.

replyEmailadministrador@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”.

contentUrlhttp://google.com.ar

Generar contenido html del automation desde una url.

eventclick_ones

Evento disparador. Ver los posibles valores en: Obtener eventos diparadores. Requerido.

relCampaign230

Id de campaña de referencia. Requerido si se informa un link específico.

specificUrlhttp://www.google.com

Link específico de la campaña de referencia. Ver los posibles valores en: Obtener links de una campaña.

daysNoClick3

Días sin clic.

mailListsIds[]36

Array de Ids de listas de contactos.

idCF12

Id de campo personalizado correspondiente a fecha específica. Ver los posibles valores en: Obtener colección de campos personalizados.

trackLinkClicks1

Seguir enlaces. Valores posibles: 0/1. Por defecto 1.

trackReads0

Contar aperturas. Valores posibles: 0/1. Por defecto 1.

trackAnalitics0

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ódigoDescripción
errorMsg_automationNotFoundNo existe automation con el ID informado.
errorMsg_nameIsRequiredNo puede pasarse en blanco el Título del automation.
errorMsg_contentOrContentUrlSólo es posible ingresar uno de los campos: Contenido HTML o Url.
errorMsg_automationSendingNo es posible modificar un automation Activo.
errorMsg_automationPendingForApprovalNo es posible modificar un automation en revisión.
errorMsg_relCampaignNotActiveLa campaña de referencia está en borrador.
errorMsg_relCampaignNotFoundNo existe campaña con el ID informado.
errorMsg_relCampaignRequiredEs requerido informar la Campaña de referencia cuando se informa un Link.
errorMsg_eventIsRequiredEs requerido informar Evento disparador cuando se informa Campaña o Link o Lista o Fecha específica o Días sin clic
errorMsg_mailListsIdsNotValidNo existe lista con el ID informado.
errorMsg_specificUrlInvalidNo existe el link informado.
errorMsg_idCFNotFoundNo existe campo personalizado Tipo = Evento anual con el ID informado.
errorMsg_relCampaignIsNotAllowedByEventNo está permitido informar Campaña de referencia para el Evento informado.
errorMsg_specificUrlIsNotAllowedByEventNo está permitido informar Link específico para el Evento informado.
errorMsg_idCFIsNotAllowedByEventNo está permitido informar Fecha específica para el Evento informado.
errorMsg_mailListsIdsIsNotAllowedByEventNo está permitido informar Listas de contactos para el Evento informado.
errorMsg_daysNoClickIsNotAllowedByEventNo está permitido informar Días sin clic para el Evento informado.
Body
KeyValueDescription
id577

Id del automation. Requerido.

namePrueba editar automation

Título del automation.

subjectHola %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”.

previewTextTexto de vista previa

Texto de vista previa.

fromAliasEmpresa S.A.

Nombre del remitente.

fromEmailempresa@ejemplo.com

Dirección de email desde la cuál saldrá la campaña. Requerido solo si se completa el campo “fromAlias”.

replyEmailcorreo@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”.

contentUrlhttp://google.com.ar

Generar contenido html del automation desde una url.

eventanual_event

Evento disparador. Ver los posibles valores en: Obtener eventos diparadores. Requerido.

relCampaign230

Id de campaña de referencia. Requerido si se informa un link específico.

specificUrlhttp://google.com

Link específico de la campaña de referencia. Ver los posibles valores en: Obtener links de una campaña.

daysNoClick3

Días sin clic.

mailListsIds[]36

Array de Ids de listas de contactos.

idCF3

Id de campo personalizado correspondiente a fecha específica. Ver los posibles valores en: Obtener colección de campos personalizados.

trackLinkClicks0

Seguir enlaces. Valores posibles: 0/1. Por defecto 1.

trackReads0

Contar aperturas. Valores posibles: 0/1. Por defecto 1.

trackAnalitics0

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ódigoDescripción
errorMsg_automationNotFoundNo existe automation con el ID informado.
errorMsg_warnPreviewLimitLimite máximo de envíos diarios excedido.
errorMsg_notAllowedNo tiene permitido enviar vistas previas.
Body
KeyValueDescription
id590

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ódigoDescripción
errorMsg_automationNotFoundNo existe automation con el ID informado.
Body
KeyValueDescription
id590

Id del automation. Requerido.

emailcorreo@ejemplo.com

Email utilizado para completar los campos personalizados incluidos en el automation.

Description

Permite generar una miniatura del contenido del automation.

Errores:

CódigoDescripción
errorMsg_automationNotFoundNo existe automation con el ID informado.
Body
KeyValueDescription
id578

Id del automation. Requerido.

width300

Ancho de la imagen. Requerido. Mínimo: 200, máximo: 600.

height600

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ódigoDescripción
errorMsg_automationNotFoundNo existe automation con el ID informado.
errorMsg_automationIntegrityFail-subjectEs necesario informar el campo subject.
errorMsg_automationIntegrityFail-replyToEs necesario informar el campo replyTo.
errorMsg_automationIntegrityFail-fromToNameEs necesario informar el campo fromToName.
errorMsg_automationIntegrityFail-fromToEs necesario informar el campo fromTo.
errorMsg_automationIntegrityFail-contentEl automation no tiene contenido.
errorMsg_campaignSendingEl automation está activo.
errorMsg_campaignPendingForApprovalEl automation está pendiente de aprobación.
errorMsg_senderDomainNotVerifiedEl dominio no está verificado.
errorMsg_relCampaignNotFoundNo existe campaña activa con el ID informado.
errorMsg_mailListsIdsNotValidNo existe lista con el ID informado.
errorMsg_noListSelectedEn necesario informar una lista.
errorMsg_invalidCampaignSelectedEn necesario informar una campaña.
errorMsg_invalidUrlEn necesario informar Url.
errorMsg_invalidCustomFieldEn necesario informar una fecha específica.
errorMsg_invalidDaysNoClickEn necesario informar días sin clics.
errorMsg_contactListFilterNo tienes permiso para activar automations.
errorMsg_spamRateErrorThresholdEl automation no pasó el chequeo de SPAM.
errorMsg_invalidMaillistsSelectedAlguna de las listas asociadas a al automation no existe.

Advertencias:

CódigoDescripción
errorMsg_campaignIntegrityFail-subjectShortEl campo subject es corto
errorMsg_campaignIntegrityFail-subjectLongEl campo subject es largo.
errorMsg_spamRateWarningThresholdEl automation pasó el chequeo de SPAM, pero puedes mejorar el resultado.
errorMsg_senderDomainNotAuthenticatedDominio no autenticado.
errorMsg_senderDmarcAllowedDomainSe recomienda usar dominios propios para mantener una buena reputación y mejorar tu capacidad de entrega.
Body
KeyValueDescription
id221

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:

CampoDescripción
originalLinkLink para usar en el automation

Errores:

CódigoDescripción
errorMsg_campaignNotFoundNo existe campaña con el ID informado o la misma está en borrador.
Body
KeyValueDescription
id1

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:

ValorDescripción
opener_campaignApertura de una campaña
click_anyClic en algún link
click_oneClic en un link específico
no_click_oneSin clic en un periodo de tiempo específico
subscriptionSuscripción a una lista de contactos
unsubscriptionDesuscripción a una lista de contactos
anual_eventEvento anual
Body
Description

Permite activar un automation en borrador, pausado o detenido.

Estructura de salida:

CampoDescripción
idID del automation activado
statusPending

Errores:

CódigoDescripción
errorMsg_automationNotFoundNo existe automation con el ID informado.
errorMsg_momentNotValidNo está permitida la opción seleccionada en Cuando enviar para el evento del automation.
errorMsg_automationIntegrityFail-subjectEs necesario informar el campo subject.
errorMsg_automationIntegrityFail-replyToEs necesario informar el campo replyTo.
errorMsg_automationIntegrityFail-fromToNameEs necesario informar el campo fromToName.
errorMsg_automationIntegrityFail-fromToEs necesario informar el campo fromTo.
errorMsg_automationIntegrityFail-contentEl automation no tiene contenido.
errorMsg_campaignSendingEl automation está activo.
errorMsg_campaignPendingForApprovalEl automation está pendiente de aprobación.
errorMsg_senderDomainNotVerifiedEl dominio no está verificado.
errorMsg_relCampaignNotFoundNo existe campaña activa con el ID informado.
errorMsg_mailListsIdsNotValidNo existe lista con el ID informado.
errorMsg_noListSelectedEn necesario informar una lista.
errorMsg_invalidCampaignSelectedEn necesario informar una campaña.
errorMsg_invalidUrlEn necesario informar Url.
errorMsg_invalidCustomFieldEn necesario informar una fecha específica.
errorMsg_invalidDaysNoClickEn necesario informar días sin clics.
errorMsg_contactListFilterNo tienes permiso para activar automations.
errorMsg_spamRateErrorThresholdEl automation no pasó el chequeo de SPAM.
errorMsg_invalidMaillistsSelectedAlguna de las listas asociadas a al automation no existe.
Body
KeyValueDescription
id590

Id del automation. Requerido.

interval3

Cantidad de días luego del evento. Requerido. Si interval = 0, se enviará apenas detectemos el evento; sino se enviará en un tiempo programado.

momentafter

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.

time12

Hora que se enviará. Requerido solo si interval > 0.

timeMinute15

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ódigoDescripción
errorMsg_automationNotFoundNo existe automation con el ID informado.
invalid_max_elementsComo máximo pueden eliminarse hasta 100 registros. Sólo para eliminación múltiple.
Body
KeyValueDescription
id470

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:

CampoDescripción
idID del automation pausado.
statusPaused

Errores:

CódigoDescripción
errorMsg_automationNotFoundNo existe automation con el ID informado.
errorMsg_automationNotActiveEl automation está en borrador.
errorMsg_automationPausedEl automation ya está pausado.
errorMsg_automationStoppedEl automation está detenido.
Body
KeyValueDescription
id457

Id de automation. Requerido.

Description

Permite reanudar un automation detenido o pausado.

Estructura de salida:

CampoDescripción
idID del automation reanudado
statusPending

Errores:

CódigoDescripción
errorMsg_automationNotFoundNo existe automation con el ID informado.
errorMsg_automationSendingEl automation está activo.
errorMsg_automationPendingForApprovalEl automation está pendiente de aprobación .
errorMsg_automationNotPausedOrStoppedEl automation está en borrador.
Body
KeyValueDescription
id457

Id de automation. Requerido.

Description

Permite duplicar un automation.

Estructura de salida:

CampoDescripción
idID del automation nuevo
nameNombre del automation nuevo

Errores:

CódigoDescripción
errorMsg_automationNotFoundNo existe automation con el ID informado.
URL Variables
KeyValueDescription
automation_id590

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:

CampoDescripción
idID de la campaña
nameTítulo de la campaña
createdFecha de creación de la campaña
type_sendTipo de envío. Valores posibles:Send Now -> Enviar ahoraOne time scheduled -> ProgramadaNot scheduled -> Sin programar
statusEstado de la campaña. Valores posibles:Draft -> BorradorPaused -> PausadaStopped -> DetenidaPendingforApproval -> Pendiente de aprobaciónSending -> Enviando o ProgramadaCompleted -> Enviada
recipients_countCantidad de destinatarios
schedule_send_dateFecha de programación de la campañaSólo para campañas con Tipo de envío = Programada
start_dateFecha de inicio de envío
finish_dateFecha fin del envío
Body
KeyValueDescription
filterPromo

Filtro por nombre o parte del nombre de la campaña.

statusDraft

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)

typeSendsendNow

Filtro por tipo de envío. Posibles valores: sendNow (Enviar ahora) / scheduled (Programada).

createDateFrom2021-05-01

Filtro por fecha de creación desde. Formato: YYYY-MM-DD.

createDateTo2021-05-28

Filtro por fecha de creación hasta. Formato: YYYY-MM-DD.

sendDateFrom2021-05-01

Filtro por fecha de envío desde. Formato: YYYY-MM-DD.

sendDateTo2021-05-28

Filtro por fecha de envío hasta. Formato: YYYY-MM-DD.

limit10

Cantidad de registros a mostrar por página. Máximo: 100.

page1

Numero de página a mostrar.

orderByname

Criterio para ordenar las campañas. Valores posibles: name/id. Por defecto: id.

orderasc

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:

CampoDescripcion
idID de la campaña
nameTítulo de la campaña
createdFecha de creación de la campaña
subjectAsunto
previewTextTexto de vista previa
fromAliasNombre del remitente
fromEmailDesde
replyEmailResponder a
maillistsLista/s de contacto/s (ID y Nombre)
segmentsSegmento (ID y nombre)
recipients_countTotal de destinatarios de la campaña
type_sendTipo de envío. Valores posibles:Send Now -> Enviar ahoraOne time scheduled -> ProgramadaNot scheduled -> Sin programar
schedule_send_dateFecha de programación de la campañaSólo para campañas con Tipo de envío = Programada
start_dateFecha de inicio de envío
finish_dateFecha fin del envío
trackLinkClicksSeguir enlaces
trackReadsContar aperturas
trackAnaliticsVincular con Google Analytics
sendReportEnviar informe
publicArchiveAgregar al archivo público
workspaceCómo fue realizado el contenido. Valores posibles:designer -> Editor visualexpertCoder -> Modo programadorexternalUrl -> Modo Url
contentContenido de la campaña en HTML
statusEstado de la campaña. Valores posibles:Draft -> BorradorPaused -> PausadaStopped -> DetenidaPendingforApproval -> Pendiente de aprobaciónSending -> Enviando o ProgramadaCompleted -> Enviada
resend.ofCampaignCampaña de la cúal es reenvío. Sólo se muestra para las campañas que son reenvíos de otras.
resend.typeTipo 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.daysDías para el reenvío. Sólo se muestra para las campañas que tienen reenvíos automáticos configurados.
resend.hoursHora de reenvío. Sólo se muestra para las campañas que tienen reenvíos automáticos configurados.
resend.minsMinutos de reenvío. Sólo se muestra para las campañas que tienen reenvíos automáticos configurados.

Errores:

CódigoDescripcion
errorMsg_campaignNotFoundNo existe campaña con el ID informado.
URL Variables
KeyValueDescription
campaing_id12

Id de campaña. Requerido.

Body
Description

Permite crear una nueva campaña. Sólo es requerido el Título.

Estructura de salida:

CampoDescripción
idID de la campaña creada
nameTítulo de la campaña

Errores:

CódigoDescripción
errorMsg_mailListsIdsOrSegmentIdSólo es posible ingresar uno de los campos: Lista/s o Segmentos.
errorMsg_contentOrContentUrlSólo es posible ingresar uno de los campos: Contenido HTML o Url.
Body
KeyValueDescription
namePromociones día del padre

Título de la campaña. Requerido.

subjectHola %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”.

previewTextTexto para la vista previa

Texto de vista previa.

fromAliasEmpresa S.A.

Nombre del remitente.

fromEmailadministrador@ejemplo.com

Dirección de email desde la cuál saldrá la campaña. Requerido solo si se completa el campo “fromAlias”.

replyEmailadministrador@ejemplo.com

Dirección email para “Responder a”.

mailListsIds[]1

Array de Ids de listas de contactos.

segmentId19

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”.

contentUrlhttp://google.com.ar

Generar contenido html de la campaña desde una url.

trackLinkClicks1

Seguir enlaces. Valores posibles: 0/1. Por defecto 1.

trackReads0

Contar aperturas. Valores posibles: 0/1. Por defecto 1.

trackAnalitics0

Vincular con Google Analytics. Valores posibles: 0/1. Por defecto 1.

sendReport0

Enviar reporte. Valores posibles: 0/1. Por defecto 1.

publicArchive1

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ódigoDescripción
errorMsg_campaignNotFoundNo existe campaña con el ID informado.
errorMsg_mailListsIdsOrSegmentIdSólo es posible ingresar uno de los campos: Lista/s o Segmentos.
errorMsg_contentOrContentUrlSólo es posible ingresar uno de los campos: Contenido HTML o Url.
errorMsg_campaignPausedLa campaña está pausada.
errorMsg_campaignSendingLa campaña está enviándose o programada.
errorMsg_campaignPendingForApprovaLa campaña está pendiente de aprobación.
errorMsg_campaignCompletedLa campaña está enviada.
Body
KeyValueDescription
id4

Id de la campaña. Requerido.

namePrueba editar campaña

Nombre de la campaña.

subjectHola %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”.

previewTextTexto de vista previa

Texto de vista previa.

fromAliasEmpresa S.A.

Nombre del remitente.

fromEmailempresa@ejemplo.com

Dirección de email desde la cuál saldrá la campaña. Requerido solo si se completa el campo “fromAlias”.

replyEmailcorreo@ejemplo.com

Dirección email para “Responder a”.

mailListsIds[]2

Array de Ids de listas de contactos.

segmentId1

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”.

contentUrlhttp://google.com.ar

Generar contenido html de la campaña desde una url.

trackLinkClicks0

Seguir enlaces. Valores posibles: 0/1. Por defecto 1.

trackReads0

Contar aperturas. Valores posibles: 0/1. Por defecto 1.

trackAnalitics0

Vincular con Google Analytics. Valores posibles: 0/1. Por defecto 1.

sendReport0

Enviar reporte. Valores posibles: 0/1. Por defecto 1.

publicArchive1

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ódigoDescripción
errorMsg_campaignNotFoundNo existe campaña con el ID informado.
errorMsg_warnPreviewLimitLimite máximo de envíos diarios excedido.
errorMsg_notAllowedNo tiene permitido enviar vistas previas.
Body
KeyValueDescription
id1

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ódigoDescripción
errorMsg_campaignNotFoundNo existe campaña con el ID informado.
Body
KeyValueDescription
id1

Id de la campaña. Requerido.

emailcorreo@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ódigoDescripción
errorMsg_campaignNotFoundNo existe campaña con el ID informado.
errorMsg_campaignIntegrityFail-subjectEs necesario completar el campo subject.
errorMsg_campaignIntegrityFail-replyToEs necesario completar el campo replyTo.
errorMsg_campaignIntegrityFail-fromToNameEs necesario completar el campo fromToName.
errorMsg_campaignIntegrityFail-fromToEs necesario completar el campo fromTo.
errorMsg_campaignIntegrityFail-contentLa campaña no tiene contenido.
errorMsg_noListNoSegmentSelectedEs necesario asociar una lista de emails o un segmento.
errorMsg_campaignPendingForApprovalLa campaña está pendiente de aprobación.
errorMsg_campaignCompletedLa campaña está enviada.
errorMsg_maxSimultaneousCampaignLimitExceededAlcanzó el limite máximo de campañas enviándose simultáneamente.
errorMsg_senderDomainNotVerifiedEl dominio no está verificado.
errorMsg_noContactsInMailListsAlguna de las listas no poseen contactos.
errorMsg_noContactsInSegmentsEl segmento no posee contactos.
errorMsg_contactListFilterNo tienes permiso para enviar campañas.
errorMsg_spamRateErrorThresholdLa campaña no pasó el chequeo de SPAM.
errorMsg_invalidMaillistsSelectedAlguna de las listas asociadas a la campaña no existe.

Advertencias:

CódigoDescripción
errorMsg_campaignIntegrityFail-subjectShortEl campo subject es corto
errorMsg_campaignIntegrityFail-subjectLongEl campo subject es largo.
errorMsg_spamRateWarningThresholdLa campaña pasó el chequeo de SPAM, pero puedes mejorar el resultado.
errorMsg_senderDomainNotAuthenticatedDominio no autenticado.
errorMsg_senderDmarcAllowedDomainSe recomienda usar dominios propios para mantener una buena reputación y mejorar tu capacidad de entrega.
Body
KeyValueDescription
id3

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:

CampoDescripción
idID de la campaña enviada
statusPending

Errores:

CódigoDescripción
errorMsg_campaignPausedLa campaña está pausada.
errorMsg_campaignSendingLa campaña está enviándose o programada.
errorMsg_campaignPendingForApprovalLa campaña está pendiente de aprobación.
errorMsg_campaignCompletedLa campaña está enviada.
errorMsg_campaignNotFoundNo existe campaña con el ID informado.
errorMsg_campaignIntegrityFail-subjectEs necesario completar el campo subject.
errorMsg_campaignIntegrityFail-replyToEs necesario completar el campo replyTo.
errorMsg_campaignIntegrityFail-fromToNameEs necesario completar el campo fromToName.
errorMsg_campaignIntegrityFail-fromToEs necesario completar el campo fromTo.
errorMsg_campaignIntegrityFail-contentLa campaña no tiene contenido.
errorMsg_noListNoSegmentSelectedEs necesario asociar una lista de emails o un segmento.
errorMsg_maxSimultaneousCampaignLimitExceededAlcanzó el limite máximo de campañas enviándose simultáneamente.
errorMsg_senderDomainNotVerifiedEl dominio no está verificado.
errorMsg_noContactsInMailListsAlguna de las listas no poseen contactos.
errorMsg_noContactsInSegmentsEl segmento no posee contactos.
errorMsg_contactListFilterNo tienes permiso para enviar campañas.
errorMsg_spamRateErrorThresholdLa campaña no pasó el chequeo de SPAM.
errorMsg_invalidMaillistsSelectedAlguna de las listas asociadas a la campaña no existe.
Body
KeyValueDescription
id4

Id de la campaña. Requerido.

sendNow0

Enviar ahora. Valores posibles: 1 (Enviar ahora) y 0 (Programar). Sólo es requerido cuando la campaña está en borrador.

sendDate2022-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).

resend1

Programar reenvío. Valores posibles: 0 (No) y 1 (Sí). Por defecto 0.

resendType2

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)

resendDays7

Cantidad de días para el reenvío. Requerido si Programar reenvío = 1. Máximo 999, mínimo: 1.

resendHours17

Hora para reenvío. Requerido si Programar reenvío = 1. Máximo 23, mínimo: 0.

resendMins40

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:

CampoDescripción
idID de la campaña pausada.
statusPaused

Errores:

CódigoDescripción
errorMsg_campaignNotFoundNo existe campaña con el ID informado.
errorMsg_campaignNotActiveLa campaña está en borrador.
errorMsg_campaignPausedLa campaña ya está pausada.
errorMsg_campaignCompletedLa campaña está enviada.
errorMsg_campaignStoppedLa campaña está detenida.
errorMsg_campaignNotPausedLa campaña no pudo ser pausada.
Body
KeyValueDescription
id112

Id de campaña. Requerido.

Description

Permite detener una campaña que está enviándose, programada, en revisión o pausada.

Estructura de salida:

CampoDescripción
idID de la campaña detenida
statusStopped

Errores:

CódigoDescripción
errorMsg_campaignNotFoundNo existe campaña con el ID informado.
errorMsg_campaignNotActiveLa campaña está en borrador.
errorMsg_campaignCompletedLa campaña está enviada.
errorMsg_campaignStoppedLa campaña ya está detenida.
errorMsg_campaignNotStoppedLa campaña no pudo ser detenida.
Body
KeyValueDescription
id112

Id de campaña. Requerido.

Description

Permite reanudar una campaña detenida o pausada.

Estructura de salida:

CampoDescripción
idID de la campaña reanudada
statusSending

Errores:

CódigoDescripción
errorMsg_campaignNotFoundNo existe campaña con el ID informado.
errorMsg_campaignSendingLa campaña está enviándose o programada.
errorMsg_campaignPendingForApprovalLa campaña está pendiente de aprobación .
errorMsg_campaignCompletedLa camapaña está enviada.
errorMsg_campaignNotPausedOrStoppedLa campaña está en borrador.
campaignBlockedSe detectaron ciertos inconvenientes en el contenido de tu campaña.
Body
KeyValueDescription
id127

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ódigoDescripción
errorMsg_campaignNotFoundNo existe campaña con el ID informado.
invalid_max_elementsComo máximo pueden eliminarse hasta 100 registros. Sólo para eliminación múltiple.
Body
KeyValueDescription
id113

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:

CampoDescripción
idID de la campaña nueva
nameNombre de la campaña nueva

Errores:

CódigoDescripción
errorMsg_campaignNotFoundNo existe campaña con el ID informado.
URL Variables
KeyValueDescription
campaing_id

Id de campaña. Requerido.

Description

Permite reenviar una campaña.

Estructura de salida:

CampoDescripción
idID de la campaña reenviada
nameNombre de la campaña reenviada

Errores:

CódigoDescripción
errorMsg_campaignNotFoundNo existe campaña con el ID informado.
errorMsg_emptyMaillistsOrSegmentLa campaña no se puede reenviar porque la lista de contactos o el segmento ya no existe.
errorMsg_campaignNotCompletedLa campaña no fue enviada.
Body
KeyValueDescription
id11

Id de la campaña a reenviar. Requerido.

type4

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)

sendNow1

Enviar ahora. Requerido. Valores posibles: 1 (Enviar ahora) y 0 (Programar).

sendDate2022-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ódigoDescripción
errorMsg_campaignNotFoundNo existe campaña con el ID informado.
Body
KeyValueDescription
id26

Id de la campaña. Requerido.

width300

Ancho de la imagen. Requerido. Mínimo: 200, máximo: 600.

height600

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:

CampoDescripción
idID del campo personalizado
nameNombre del campo personalizado
codeCódigo del campo personalizado.Con este código podrás incluir los campos personalizados en el asunto y contenido de la campaña
typeTipo de campo. Ver los posibles valores en: Obtener tipos de campos personalizados
validationTipo 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
validationCustomRegExpValidación personalizada. Se muestra solo si Validación = Personalizada)
options_valuesOpciones posibles. Se muestra solo para Tipo de campo = Listado o Listado con selección múltiple o Listado con selección única
value_defaultValor por defecto. Se muestra solo para Tipo de campo = Campo de texto o Campo oculto o Evento anual
date_valueFecha por defecto. Se muestra solo para Tipo de campo = Evento anual
Body
KeyValueDescription
namecampo

Filtro por nombre o parte del nombre del campo personalizado.

typeText field

Filtro por tipo de campo. Ver los posibles valores en: Obtener tipos de campos personalizados.

limit10

Cantidad de registros a mostrar por página. Máximo: 100.

page1

Numero de página a mostrar.

orderByname

Criterio para ordenar los campos. Valores posibles: nombre/id. Por defecto: id.

orderasc

Tipo de ordenamiento. Valores posibles: asc/desc. Por defecto: desc.

Description

Devuelve el detalle de un campo personalizado.

Estructura de salida:

CampoDescripción
idID del campo personalizado.
nameNombre del campo personalizado
codeCódigo del campo personalizado.Con este código podrás incluir los campos personalizados en el asunto y contenido de la campaña
typeTipo de campo. Ver los posibles valores en: Obtener tipos de campos personalizados
validationTipo 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.
validationCustomRegExpValidación personalizada. Se muestra solo si Validación = Personalizada)
options_valuesOpciones posibles. Se muestra solo para Tipo de campo = Listado o Listado con selección múltiple o Listado con selección única
value_defaultValor por defecto. Se muestra solo para Tipo de campo = Campo de texto o Campo oculto o Evento anual
date_valueFecha por defecto. Se muestra solo para Tipo de campo = Evento anual

Errores:

CódigoDescripción
errorMsg_customFieldNotFoundNo existe campo personalizado con el ID informado.
URL Variables
KeyValueDescription
customfield_id3

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:

ValorDescripción
Do not ApplyDesactivar
Numeric OnlyAceptar sólo dígitos
Alpha OnlyAceptar solo letras y espacios
Alpha Numeric OnlyAceptar solo letras, números y espacios
Email Format CheckAceptar sólo direcciones de correo
CustomPersonalizada
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:

ValorDescripción
Text fieldCampo de texto
Hidden fieldCampo oculto
Check boxListado con selección múltiple
Radio buttonListado con selección única
Anual DateEvento anual
Drop listListado
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ódigoDescripción
valueDefaultWithValidationCustomRegExpEl valor por defecto no cumple con la validación personalizada.
Body
KeyValueDescription
nameApellido

Nombre del campo. Requerido.

typeText field

Tipo de campo. Ver los posibles valores en: Obtener tipos de campos personalizados. Requerido.

validation_typeDo 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_defaultDesconocido

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_value02-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ódigoDescripcion
errorMsg_customFieldNotFoundNo existe campo personalizado con el ID informado.
valueDefaultWithValidationCustomRegExpEl valor por defecto no cumple con la validación personalizada.
Body
KeyValueDescription
id8

Id de campo personalizado a modificar. Requerido.

nameFecha de nacimiento

Nombre del campo. Requerido.

typeAnual Date

Tipo de campo. Ver los posibles valores en: Obtener tipos de campos personalizados. Requerido.

validation_typeCustom

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_defaultDesconocido

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_value02-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ódigoDescripción
errorMsg_customFieldNotFoundNo existe campo personalizado con el ID informado.
errorMsg_customFieldIsUsedNo puede eliminarse el campo personalizado debido a que está siendo usado en algún segmento, formulario o automation.
URL Variables
KeyValueDescription
customfield_id5

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:

CampoDescripción
idID del contacto
emailEmail del contacto
createdFecha de creación
lastSendFecha de último envío
suscriptionsCantidad de listas a las que está suscripto

Errores:

CódigoDescripción
errorMsg_mailListNotFoundNo de encontró lista con el ID informado.
Body
KeyValueDescription
emailluis

Filtro por email o parte del email del contacto.

listId2

Filtro por lista de contactos.

limit10

Cantidad de registros a mostrar por página. Máximo: 100.

page1

Numero de página a mostrar.

orderByid

Criterio para ordenar los contactos. Valores posibles: email/id. Por defecto: id

orderasc

Tipo de ordenamiento. Valores posibles: asc/desc. Por defecto: desc.

Description

Devuelve el detalle de un contacto.

Estructura de salida:

CampoDescripción
idID del contacto
emailEmail del contacto
createdFecha de creación
lastActivityFecha última actividad
mailListsLista/s en la/s que está suscripto (ID y Nombre)
customFieldsCampos personalizados (ID, Nombre, Tipo y Valor)
lastSendFecha de último envío
readsAperturas totales
clicksClicks totales
hardBounceRebotes duros
softBounceRebotes blandos
sharedCompartidos
unsubscriptionDesuscripciones
complaintQuejas

Errores:

CódigoDescripción
errorMsg_contactNotFoundNo existe contacto con el ID informado.
URL Variables
KeyValueDescription
contact_id2

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:

CampoDescripción
idID del contacto creado
emailEmail del contacto

Errores:

CódigoDescripción
errorMsg_contactAlreadyExistYa existe un contacto con el mismo correo.
customsFieldsNotFoundNo existe el campo personalizado indicado.
Body
KeyValueDescription
emailsofia@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ódigoDescripcion
errorMsg_contactNotFoundNo existe contacto con el ID informado.
customsFieldsNotFoundNo existe el campo personalizado indicado.
Body
KeyValueDescription
id6

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ódigoDescripción
errorMsg_mailListNotFoundNo existe lista de contactos con el ID informado.
invalidContactsNinguno de los contactos fue suscripto ya sea porque no existen o porque están excluídos
Body
KeyValueDescription
contactsIds[]4

Array de Ids de contactos a suscribir. Requerido. Máximo: 100 registros.

listId1

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ódigoDescripción
errorMsg_mailListNotFoundNo existe lista de contactos con el ID informado.
invalidContactsNinguno de los contactos fue desuscripto ya sea porque no existen o porque no estaban suscriptos en la lista indicada.
Body
KeyValueDescription
contactsIds[]12

Array de Ids de contactos a desuscribir. Requerido. Máximo: 100 registros.

listId1

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ódigoDescripción
errorMsg_contactsNotFoundNo existe ninguno de los contactos informados.
Body
KeyValueDescription
contactsIds[]49

Array de Ids de contactos a eliminar. Requerido.

Description

Permite cargar los contactos desde una archivo CSV.

Errores:

CódigoDescripción
errorMsg_invalidCountColumnsInParamsNo coinciden la cantidad de columnas del archivo con las indicadas en los parámetros.
errorMsg_columnEmailNotFoundEs requerido que esté parametrizada la columna Email.
errorMsg_mailListNotFoundNo existe lista con el ID indicado.
Body
KeyValueDescription
csv

Archivo CSV. Requerido.

mailList6

Id de la lista. Requerido.

qualifierdoubleQuote

Delimitador de campos. Requerido. Valores posibles: quote (Comilla simple) y doubleQuote (Comilla doble)

delimitercomma

Separador de columnas. Requerido. Valores posibles: comma (Coma) / semicolon (Punto y coma) / numberSign (Numeral) / dollarSign (Símbolo pesos)

ignoreFirstRow1

Ignorar la primera fila del archivo. Requerido. Valores posibles: 0 (No) y 1 (Sí).

columns[0]Email

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:

CampoDescripción
idID de la cuenta
nameNombre y apellido
usernameNombre de usuario
emailCorreo electrónico
timeZoneZona horaria. Ver los posibles valores en: Obtener zonas horarias
countryPaís. Ver los posibles valores en: Obtener países
subscription.TypeTipo de plan. Valores posibles:Prepaid –> PrepagoMonthly –> Mensual
subscription.QuotaCantidad de envíos del plan. Solo se muestra para Tipo de plan = Mensual
subscription.TermBeginFecha de inicio. Solo se muestra para Tipo de plan = Mensual
subscription.TermEndFecha de fin. Solo se muestra para Tipo de plan = Mensual
subscription.CreditsCréditos disponibles
createdFecha de creación de la cuenta
publicArchivesURLUrl para acceder al archivo público de campañas
Description

Permite editar la configuración de la cuenta.

Body
KeyValueDescription
nameJuan Pérez

Nombre y apellido. Requerido.

emailcuenta@ejemplo.com

Email. Requerido.

timezone-10800

Zona Horaria. Requerido. Ver los posibles valores en: Obtener zonas horarias.

countryar

Pais. Requerido. Ver los posibles valores en: Obtener países.

Description

Devuelve estadísticas de la cuenta del administrador.

Estructura de salida:

CampoDescripción
TotalSentTotal de envíos del último mes
AvgMonthlyTotalSentPromedio de envíos en los últimos seis meses
campaigns.CountTotal de campañas creadas
campaigns.SentTotal de envíos en campañas
autoresponders.CountTotal de automation creados
autoresponders.SentTotal de envíos en automations
maillists.CountCantidad de listas activas
activeMembers.CountCantidad de contactos activos
reads.CountTotal de aperturas en campañas y automations (aperturas totales)
clicks.CountTotal 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:

CampoDescripción
labelDescripción de la zona horaria
valueCó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:

CampoDescripción
labelDescripción del país
valueCó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:

CampoDescripción
idID del dominio
domainNombre del dominio
statusEstado del dominio. Valores posibles:NotVerified (No verificado) /Pending (Pendiente de verificación) / Verified (Verificado sin autenticar) / Authenticated (Autenticado)
Body
KeyValueDescription
nametudominio.com

Filtro por nombre de dominio

statusAuthenticated

Filtro por estado del dominio. Posible valores: Pending (Pendiente de verificación) / Verified (Verificado sin autenticar) / NotVerified (No verificado) / Authenticated (Autenticado).

limit10

Cantidad de registros a mostrar por página. Máximo: 100.

page1

Numero de página a mostrar.

orderByname

Criterio para ordenar los dominios. Valores posibles: name/id. Por defecto: id.

orderasc

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
KeyValueDescription
emailcorreo@ejemplo.com

Filtro por email.

limit5

Cantidad de registros a mostrar por página. Máximo: 100.

page1

Numero de página a mostrar.

orderByemail

Criterio para ordenar las exclusiones. Valores posibles: email/id. Por defecto: id.

orderasc

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ódigoDescripción
msg_listsNotFoundsNo existe ninguna de las listas informadas.
Body
KeyValueDescription
always0

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ódigoDescripción
errorMsg_exclusionNotFoundNo existe exclusión con el ID informado.
URL Variables
KeyValueDescription
exclusion_id3

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:

CampoDescripción
idID del formulario
nameNombre del formulario
Body
KeyValueDescription
nameprueba

Filtro por nombre o parte del nombre del formulario.

limit10

Cantidad de registros a mostrar por página. Máximo: 100.

page1

Numero de página a mostrar.

orderByname

Criterio para ordenar los formularios. Valores posibles: nombre/id. Por defecto: id.

orderasc

Tipo de ordenamiento. Valores posibles: asc/desc. Por defecto: desc.

Description

Devuelve el detalle de un formulario.

Estructura de salida:

CampoDescripción
idID del formulario
nameNombre del formulario
mailListsLista/s de contacto/s (ID y Nombre)
urlSubsOKURL de suscripción satisfactoria
urlSubsErrorURL de suscripción errónea
notificationEmailCorreo para recibir notificación ante la suscripción de un contacto
emailConfirm.subjectAsunto del correo de confirmación
emailConfirm.fromNameRemitente del correo de confirmación
emailConfirm.fromEmailEmail “desde” del correo de confirmación
emailConfirm.replyToEmailEmail “para responder” del correo de confirmación
urlConfirmOKURL confirmación de suscripción satisfactoria
urlConfirmErrorURL confirmación de suscripción errónea
scriptFormWebSiteCódigo para tu sitio web
urlFormWebSiteEnlace para redes sociales
codeQRCódigo QR

Errores:

CódigoDescripción
errorMsg_formNotFoundNo existe formulario con el ID informado.
URL Variables
KeyValueDescription
form_id1

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:

CampoDescripción
idID de la lista
nameNombre de la lista
countCantidad de contactos
lastSendFecha de último envío
Body
KeyValueDescription
namenombre

Filtro por nombre o parte del nombre de lista.

limit10

Cantidad de registros a mostrar por página. Máximo: 100.

page1

Numero de página a mostrar.

orderByid

Criterio para ordenar las listas. Valores posibles: name/id. Por defecto: id.

orderdesc

Tipo de ordenamiento. Valores posibles: asc/desc. Por defecto: desc.

Description

Permite crear una nueva lista.

Estructura de salida:

CampoDescripción
idID de la lista creada
nameNombre de la lista
Body
KeyValueDescription
nameLista nueva

Nombre de la lista. Requerido. No se permiten caracteres especiales.

Description

Permite editar una lista.

Errores:

CódigoDescripción
errorMsg_contactListNotFoundNo existe lista con el ID informado.
Body
KeyValueDescription
id1

Id de la lista. Requerido.

nameLista de prueba

Nombre de la lista. Requerido. No se permiten caracteres especiales.

Description

Permite eliminar una lista.

Errores:

CódigoDescripción
errorMsg_listContactNotFoundNo existe lista con el ID informado.
URL Variables
KeyValueDescription
list_id10

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ódigoDescripción
invalid_max_elementsComo máximo pueden eliminarse hasta 100 registros.
Body
KeyValueDescription
ids[]6

Array de Ids de listas a eliminar. Requerido. Como máximo 100.

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:

CampoDescripción
campaign.nameNombre de la campaña/automation.
campaign.sendDateFecha y hora de envío. Sólo para campañas.
publicURLUrl reporte público
delivery.totalTotal 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.AmountContactos repetidos
delivery.exclusions.duplicated.PercentagePorcentaje de contactos repetidos sobre el total de contactos excluidos del envío
delivery.exclusions.banned.AmountContactos en lista de exclusión
delivery.exclusions.banned.PercentagePorcentaje de contactos en lista de exclusión sobre el total de contactos excluidos del envío
delivery.exclusions.totalContactos excluidos del envío (Contactos repetidos + Contactos en lista de exclusión)
delivery.exclusions.totalPercentagePorcentaje de contactos excluídos sobre el total de contactos
delivery.bounces.hard.AmountRebotes duros
delivery.bounces.hard.PercentagePorcentaje de rebotes duros sobre el total de rebotes
delivery.bounces.soft.AmountRebotes blandos
delivery.bounces.soft.PercentagePorcentaje de rebotes blandos sobre el total de rebotes
delivery.bounces.totalTotal de rebotes. Son los mails que no pudieron entregarse porque los servidores de los correos de destino los rechazaron
delivery.bounces.totalPercentagePorcentaje de rebotes sobre el total de contactos
delivery.pendingTotal de pendientes. Son las direcciones de correo a las que el sistema aún no ha enviado el mail
delivery.pendingPercentagePorcentaje de pendientes sobre el total de contactos
delivery.deliveredTotal entregados. Comprende el total de mails que llegaron a destino
delivery.deliveredPercentagePorcentaje de entregados sobre el total de contactos
performance.readsCantidad de veces que fue abierta la campaña/automation
performance.uniqueReadsCantidad de contactos que abrieron la campaña/automation
performance.readsPercentagePorcentaje de contactos que abrieron la campaña/automation sobre el total entregado
performance.clicksCantidad de clicks que se hicieron en la campaña/automation
performance.uniqueClicksCantidad de contactos que hicieron click en la campaña /automation
performance.clicksPercentagePorcentaje de contactos que hicieron click en la campaña/automation sobre el total entregado
performance.shared.totalTotal de compartidos
performance.shared.forwardto.AmountTotal de compartidos por correo
performance.shared.forwardto.PercentagePorcentaje de compartidos por correo
performance.shared.facebook.AmountTotal de compartidos por Facebook
performance.shared.facebook.PercentagePorcentaje de compartidos por Facebook
performance.shared.linkedin.AmountTotal de compartidos por LinkedIn
performance.shared.linkedin.PercentagePorcentaje de compartidos por LinkedIn
performance.shared.twitter.AmountTotal de compartidos por Twitter
performance.shared.twitter.PercentagePorcentaje de compartidos por Twitter
performance.shared.pinterest.AmountTotal de compartidos por Pinterest
performance.shared.pinterest.PercentagePorcentaje de compartidos por Pinterest
performance.shared.whatsapp.AmountTotal de compartidos por Whatsapp
performance.shared. whatsapp.PercentagePorcentaje de compartidos por Whatsapp
performance.unsubscriptions.totalTotal de desuscripciones
performance.unsubscriptions.alreadyUnsubscribed.AmountTotal de desuscriptos con motivo Ya me desuscribi
performance.unsubscriptions.alreadyUnsubscribed.PercentagePorcentaje de desuscriptos con motivo Ya me desuscribi
performance.unsubscriptions.irrelevant.AmountTotal de desuscriptos con motivo Contenidos irrelevantes
performance.unsubscriptions.irrelevant.PercentagePorcentaje de desuscriptos por Contenidos irrelevantes
performance.unsubscriptions.neverSignUp.AmountTotal de desuscriptos con motivo Nunca me suscribi
performance.unsubscriptions.neverSignUp.PercentagePorcentaje de desuscriptos con motivo Nunca me suscribi
performance.unsubscriptions.spam.AmountTotal de desuscriptos con motivo Lo considero SPAM
performance.unsubscriptions.spam.PercentagePorcentaje de desuscriptos con motivo Lo considero SPAM
performance.unsubscriptions.tooOften.AmountTotal de desuscriptos con motivo Demasiada frecuencia
performance.unsubscriptions.tooOften.PercentagePorcentaje de desuscriptos con motivo Demasiada frecuencia
performance.unsubscriptions.other.AmountTotal de desuscriptos con otros motivos
performance.unsubscriptions.other.PercentagePorcentaje de desuscriptos con otros motivos
performance.complaintsCantidad de quejas. Es el número de destinatarios que marcaron la campaña/automation como spam
devices.mobileTotalTotal de aperturas en Móviles
devices.mobilePercentagePorcentaje de aperturas en Móviles
devices.mobileAgentsDetalle de aperturas en Móviles (Cantidad por agente y Porcentaje)
devices.desktopTotalTotal de aperturas en Escritorio
devices.desktopPercentagePorcentaje de aperturas en Escritorio
devices.desktopAgentsDetalle de aperturas en Escritorio (Cantidad por agente y Porcentaje)
devices.tabletTotalTotal de aperturas en Tablets
devices.tabletPercentagePorcentaje de aperturas en Tablets
devices.tabletAgentsDetalle de aperturas en Tablets (Cantidad por agente y Porcentaje)
devices.unknownTotalTotal de aperturas en Dispositvos desconocidos
devices.unknownPercentagePorcentaje de aperturas en Dispositvos desconocidos

Errores:

CódigoDescripción
errorMsg_campaignNotFoundNo existe campaña/automation con el ID informado.
URL Variables
KeyValueDescription
campaign_id100

Id de campaña/automation. Requerido.

Description

Devuelve el detalle de las aperturas de la campaña/automation.

Estructura de salida:

CampoDescripción
emailEmail del contacto que realizó la apertura
dateFecha y hora de la apertura
countryCodePaís donde se abrió la campaña/automation (Código ISO)
cityCuidad donde se abrió la campaña/automation (Descripción)
platformDispositivo donde se abrió la campaña/automation
latitudeCoordenada geográfica donde se abrió la campaña/automation (latitud)
longitudeCoordenada geográfica donde se abrió la campaña/automation (longitud)
appAplicación donde se abrió la campaña/automation

Errores:

CódigoDescripción
errorMsg_campaignNotFoundNo existe campaña/automation con el ID informado.
Body
KeyValueDescription
id386

Id de campaña/automation. Requerido.

limit10

Cantidad de registros a mostrar por página. Máximo: 100.

page1

Numero de página a mostrar.

orderasc

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:

CampoDescripción
dateFecha y hora del click
urlUrl donde se hizó click
emailEmail del contacto que realizó el click

Errores:

CódigoDescripción
errorMsg_campaignNotFoundNo existe campaña/automation con el ID informado.
Body
KeyValueDescription
id386

Id de campaña/automation. Requerido.

limit10

Cantidad de registros a mostrar por página. Máximo: 100.

page1

Numero de página a mostrar.

orderasc

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:

CampoDescripción
dateFecha y hora que se compartió la campaña/automation
viaMedio donde se compartió la campaña/automation. Valores posibles:forwardto -> Correofacebook -> Facebooktwitter -> Twitterlinkedin -> LinkedInpinterest -> Pinterestwhatsapp -> WhatsApp
emailEmail del contacto que compartió la campaña/automation

Errores:

CódigoDescripción
errorMsg_campaignNotFoundNo existe campaña/automation con el ID informado.
Body
KeyValueDescription
id386

Id de campaña/automation. Requerido.

limit10

Cantidad de registros a mostrar por página. Máximo: 100.

page1

Numero de página a mostrar.

orderasc

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:

CampoDescripción
dateFecha y hora del rebote
typeTipo de rebote. Valores posibles:soft -> Rebote blandohard -> Rebote duro
emailEmail del contacto que rebotó

Errores:

CódigoDescripción
errorMsg_campaignNotFoundNo existe campaña/automation con el ID informado.
Body
KeyValueDescription
id386

Id de campaña/automation. Requerido.

limit10

Cantidad de registros a mostrar por página. Máximo: 100.

page1

Numero de página a mostrar.

orderasc

Ordenar por fecha. Valores posibles: asc/desc. Por defecto: desc.

typehard

Filtro por tipo de rebote. Valores posibles: soft/hard.

Description

Devuelve el detalle de desuscripciones realizadas en la campaña/automation.

Estructura de salida:

CampoDescripción
dateFecha y hora de la desuscripción
reasonRazón de la desuscripción. Valores posibles:irrelevant -> Contenidos irrelevantestooOften -> Demasiada frecuencianeverSignUp -> Nunca me suscribíalreadyUnsubscribed -> Ya me desuscribíspam -> Lo considero SPAMother -> Otros
noteNotas adicionales cuando selecciona motivo = Otros
emailEmail del contacto que se desuscribió

Errores:

CódigoDescripción
errorMsg_campaignNotFoundNo existe campaña/automation con el ID informado.
Body
KeyValueDescription
id386

Id de campaña/automation. Requerido.

limit10

Cantidad de registros a mostrar por página. Máximo: 100.

page1

Numero de página a mostrar.

orderasc

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:

CampoDescripción
dateFecha y hora de la queja
emailEmail del contacto que realizó la queja

Errores:

CódigoDescripción
errorMsg_campaignNotFoundNo existe campaña/automation con el ID informado.
Body
KeyValueDescription
id386

Id de campaña/automation. Requerido.

limit10

Cantidad de registros a mostrar por página. Máximo: 100.

page1

Numero de página a mostrar.

orderasc

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:

CampoDescripción
emailEmail del contacto excluido
reasonRazón de la exclusión. Valores posibles:duplicated -> Duplicadobanned -> En lista de exclusión

Errores:

CódigoDescripción
errorMsg_campaignNotFoundNo existe campaña/automation con el ID informado.
Body
KeyValueDescription
id386

Id de campaña/automation. Requerido.

limit10

Cantidad de registros a mostrar por página. Máximo: 100.

page1

Numero de página a mostrar.

orderasc

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ódigoDescripción
errorMsg_campaignNotFoundNo existe campaña/automation con el ID informado
errorMsg_campaignStatisticsNotFoundLa campaña/automation todavía no fue enviada
errorMsg_campaignSentsNotFoundEl archivo ya no está disponible por haber pasado más de 6 meses desde el envío de la campaña/automation
Body
KeyValueDescription
id352

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ódigoDescripción
errorMsg_campaignNotFoundNo existe campaña/automation con el ID informado
errorMsg_campaignStatisticsNotFoundLa campaña/automation todavía no fue enviada
errorMsg_campaignDuplicatesNotFoundEl archivo ya no está disponible por haber pasado más de 6 meses desde el envío de la campaña/automation
Body
KeyValueDescription
id9

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:

CampoDescripción
dateFecha y hora de la apertura
countryCodePaís desde el que se abrió
platformDispositvo desde el que se abrió
campaignNameNombre de la campaña

Errores:

CódigoDescripción
errorMsg_contactNotFoundNo existe contacto con el ID informado.
Body
KeyValueDescription
id2

Id del contacto. Requerido.

limit10

Cantidad de registros a mostrar por página. Máximo: 100.

page1

Numero de página a mostrar.

orderasc

Ordenar por fecha. Valores posibles: asc/desc. Por defecto: desc.

Description

Devuelve el detalle de los clicks realizados por el contacto.

Estructura de salida:

CampoDescripción
dateFecha y hora del click
urlURL donde hizo click
campaignNameNombre de la campaña

Errores:

CódigoDescripción
errorMsg_contactNotFoundNo existe contacto con el ID informado.
Body
KeyValueDescription
id2

Id del contacto. Requerido.

limit10

Cantidad de registros a mostrar por página. Máximo: 100.

page1

Numero de página a mostrar.

orderasc

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:

CampoDescripción
dateFecha y hora que compartió la campaña
viaMedio donde se compartió la campaña. Valores posibles:forwardto -> Correofacebook -> Facebooktwitter -> Twitterlinkedin -> LinkedInpinterest -> Pinterestwhatsapp -> WhatsApp
campaignNameNombre de la campaña

Errores:

CódigoDescripción
errorMsg_contactNotFoundNo existe contacto con el ID informado.
Body
KeyValueDescription
id2

Id del contacto. Requerido.

limit10

Cantidad de registros a mostrar por página. Máximo: 100.

page1

Numero de página a mostrar.

orderasc

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:

CampoDescripción
dateFecha y hora del rebote
typeTipo de rebote. Valores posibles:soft -> Rebote blandohard -> Rebote duro
campaignNameNombre de la campaña

Errores:

CódigoDescripción
errorMsg_contactNotFoundNo existe contacto con el ID informado.
Body
KeyValueDescription
id2

Id del contacto. Requerido.

limit10

Cantidad de registros a mostrar por página. Máximo: 100.

page1

Numero de página a mostrar.

orderasc

Ordenar por fecha. Valores posibles: asc/desc. Por defecto: desc.

typehard

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:

CampoDescripción
dateFecha y hora de la desuscripción
reasonRazón de la desuscripción. Valores posibles:irrelevant -> Contenidos irrelevantestooOften -> Demasiada frecuencianeverSignUp -> Nunca me suscribíalreadyUnsubscribed -> Ya me desuscribíspam -> Lo considero SPAMother -> Otros
campaignNameNombre de la campaña

Errores:

CódigoDescripción
errorMsg_contactNotFoundNo existe contacto con el ID informado.
Body
KeyValueDescription
id2

Id del contacto. Requerido.

limit10

Cantidad de registros a mostrar por página. Máximo: 100.

page1

Numero de página a mostrar.

orderasc

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:

CampoDescripción
dateFecha y hora de la queja
campaignNameNombre de la campaña

Errores:

CódigoDescripción
errorMsg_contactNotFoundNo existe contacto con el ID informado.
Body
KeyValueDescription
id2

Id del contacto. Requerido.

limit10

Cantidad de registros a mostrar por página. Máximo: 100.

page1

Numero de página a mostrar.

orderasc

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:

CampoDescripción
idID del segmento
nameNombre del segmento
createdFecha de creación
membersCantidad de contactos
lastSendFecha de último envío
Body
KeyValueDescription
namenombre

Filtro por nombre o parte del nombre del segmento.

limit10

Cantidad de registros a mostrar por página. Máximo: 100.

page1

Numero de página a mostrar.

orderByid

Criterio para ordenar los segmentos. Valores posibles: nombre/id. Por defecto: id.

orderasc

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:

CampoDescripción
idID de la tarea
dateFecha y hora de la tarea
typeTarea 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.totalTotal de procesados. Este campo sólo se muestra para las tareas que realizan procesamientos sobre registros.
details.importedTotal de contactos importados. Este campo sólo se muestra para la tarea importContacts.
details.notImportedTotal de contactos NO importados. Este campo sólo se muestra para la tarea importContacts.
details.sourceImportTipo 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.movedTotal de contactos movidos. Este campo sólo se muestra para la tarea contactsMoved.
details.notMovedTotal de contactos NO movidos. Este campo sólo se muestra para la tarea contactsMoved.
details.copiedTotal de contactos copiados. Este campo sólo se muestra para la tarea contactsCopied.
details.notCopiedTotal de contactos NO copiados. Este campo sólo se muestra para la tarea contactsCopied.
details.campaingNameNombre de la campaña de referencia. Este campo sólo se muestra para las tareas correspondientes a Reportes de campañas.
details.nameNombre del segmento o lista. Este campo sólo se muestra para las tareas realizadas sobre segmentos o listas.
details.contactsCantidad de contactos. Este campo sólo se muestra para la tarea segmentUpdated.
downloadLinkEnlace 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.
statusEstado de la tarea. Valores posibles:completed -> Finalizadapending -> En proceso
Body
KeyValueDescription
statuscompleted

Filtro por estado de la tarea. Valores posibles: completed (Finalizadas) y pending (En proceso).