Documentación API

Utiliza nuestra HTTP API e integra EnvíaloSimple con tus propias aplicaciones, y ahorra tiempo y esfuerzo.

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.

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.

Campañas 12

Este modulo te permitirá realizar toda la gestión asociada a campañas desde la creación hasta el envío.

Description

Devuelve una lista todas las campañas. Pueden filtrarse por nombre o por estado.

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
Send Now -> Enviar ahora
One time scheduled -> Programada
Not scheduled -> Sin programar
statusEstado de la campaña
Draft -> Borrador
Paused -> Pausada
Stopped -> Detenida
PendingforApproval -> Pendiente de aprobación
Sending -> Enviando o Programada
Completed -> Enviada
schedule_send_dateFecha de programación de la campaña
Só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).

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.

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
Send Now -> Enviar ahora
One time scheduled -> Programada
Not scheduled -> Sin programar
schedule_send_dateFecha de programación de la campaña
Só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
contentContenido de la campaña en HTML
statusEstado de la campaña
Draft -> Borrador
Paused -> Pausada
Stopped -> Detenida
PendingforApproval -> Pendiente de aprobación
Sending -> Enviando o Programada
Completed -> Enviada

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
nameCampaña ejemplo

Título de la campaña. Requerido.

subjectPromociones día del padre

Asunto de la campaña.

previewTextTexto para la vista previa

Texto de vista previa.

fromAliasIndumentaria S.A.

Nombre del remitente.

fromEmailadministrador@ejemplo.com

Dirección de email desde la cuá 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

Hello World

Contenido del email en Html.

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%

Asunto de la campaña.

previewTextTexto de vista previa

Texto de vista previa.

fromAliasEmpresa S.A.

Nombre del remitente.

fromEmailempresa@ejemplo.com

Dirección de email desde la cuá 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

Hello World

Contenido del email en Html.

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.

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.

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

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


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
id197

Id de campaña. Requerido.


Description

Permite eliminar una campaña.

Estructura de salida:

CampoDescripción
idID de la campaña que fue eliminada

Errores:

CódigoDescripción
errorMsg_campaignNotFoundNo existe campaña con el ID informado.


Body
KeyValueDescription
id113

Id de campaña a eliminar. Requerido.


Campos personalizados 7

Este modulo 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.

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 7

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.


Cuenta 5

Este modulo 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 –> Prepago
Monthly –> 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



Exclusiones 3

Este modulo 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

Listas de contactos 5

Este modulo 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.



Reportes de campañas 1

Este modulo te permitirá conocer el reporte y las estadísticas de cada campaña enviada.

Description

Devuelve el reporte general de una campaña.

Estructura de salida:

CampoDescripción
campaign.nameNombre de la campaña
campaign.sendDateFecha y hora de envío
publicURLUrl reporte público
delivery.totalTotal de contactos. Es la suma de todos los contactos incluidos dentro de las listas o segmentos a los que se envió la campaña
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
performance.uniqueReadsCantidad de contactos que abrieron la campaña
performance.readsPercentagePorcentaje de contactos que abrieron la campaña sobre el total entregado
performance.clicksCantidad de clicks que se hicieron en la campaña
performance.uniqueClicksCantidad de contactos que hicieron click en la campaña
performance.clicksPercentagePorcentaje de contactos que hicieron click en la campaña 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 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 con el ID informado.


URL Variables
KeyValueDescription
campaing_id196

Id de campaña. Requerido.


Segmentos 1

Este modulo 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.




EnvíaloSimple es un producto de DonWeb