Email Marketing y Newsletter / Funcionalidades / Integracion / HTTP API

HTTP API

Disfruta las extraordinarias ventajas de utilizar nuestra API de integración. ¡Ahorra tiempo y esfuerzo!

Comienza hoy

Introduction

1.Introduction

What is HTTP API?

El API HTTP es una herramienta que te permite integrar EnvialoSimple.com con tus aplicaciones mediante simples llamadas a URLs.

La interfaz (API) te ofrece innumerables funcionalidades agrupadas por módulos para facilitar su utilización e implementación.

A través de la nueva API HTTP de EnvialoSimple.com podrás enviar tu campañas de email marketing; crear, modificar y eliminar contactos, listas de contactos y campañas; consultar estadísticas y reportes integrando todas las funcionalidades de EnvialoSimple.com en tu propia aplicación.

All URLs have the same structure:

https://app.envialosimple.com/<modulo>/<accion>?APIKey=<api key>&format=<format>

<modulo>It represents a group of actions. It may take the values:

  • campaign
  • member
  • report
  • mailist

<accion> - Specific action to be carried out. This action depends on the module. It takes values such as "list", "add", "edit", etc.

<api key> - Authentication token. These tokens can be generated from your EnvialoSimple.com account in the "Advanced configuration".

<format> - Exit format of the request. Supported formats are:

  • json
  • xml

Reply (Structure)

Todas las respuestas empiezan con un nodo "root" seguido por "ajaxResponse" si es que el formato de salida es "json" o directamente los datos después del nodo "root" si el formato de salida es XML.

Si NO se producen errores durante la ejecución de la operación se retorna un nodo "success" junto a los datos correspondientes al método. De lo contrario encontraremos un nodo "errors" con códigos de error.

Example

Success:

{
            "root": {
                "ajaxResponse": {
                    "success": true,
                    <Specific reply of the service>
                }
            }
        }

Error:

{
            "root":{
                "ajaxResponse":{
                    "errors":{
                        <Error tokens>:<Error detail if applicable>
                    }
                }
            }
        }

Useful example of a reply with an error message:

Call: https://app.envialosimple.com/member/list/format/json?count=1asdReply:
{
        "root":{
            "ajaxResponse":{
                "errors":{
                "errorMsg_formValidations":{
                    "count":[
                    "notDigits"
                        ],
                    "absolutepage": [ ],
                    "filter": [ ],
                    "orderBy": [ ],
                    "desc": [ ],
                    "MailListsIDs": [ ]
                    }
                }
            }
        }
    }

Módulo campaign

1.List campaigns

Service:

/campaign/list

It lists all campaigns filtered by name.

Parameters:

Parametercount
MandatoryNO
TypeInteger number >0
ExplanationMaximum number of campaigns to be retrieved
Examplecount=10
Parameterabsolutepage
MandatoryNO
TypeInteger number >0
ExplanationRecord page "count" to which you want to go. If count is equal to 10 and absolutepage is equal to 3, then, we will start viewing from campaign number 31
Exampleabsolutepage=3
Parameterstatus
MandatoryNO
TypeArreglo de Cadena de Caracteres
Valores Posibles:

Active(Pendiente de aprobación, pendiente, preparando o enviando)
Inactive(Borrador, pausada o detenida)

Completed(Enviada)
ExplanationStatus types by which you want to filter
Examplestatus[] = Inactive&status[] = Completed
Parameterfilter
MandatoryNO
TypeCharacter chain
ExplanationFull or part of the name by which campaigns are filtered
Examplefilter=Summer deal
ParameterorderBy
MandatoryNO
TypeCharacter chain
ExplanationValores posibles:
name (Nombre de la campaña)
id (Id de la campaña)
ExampleorderBy=name
Parameterdesc
MandatoryNO
TypeNúmero Entero
Valores posibles:
1 (si)
0 (no)
ExplanationIt determines whether the order of the list is descending or ascending
Exampledesc=1

Errors:

errorMsg_formValidations
One or more of the entry parameters are incorrect, missing or mandatory. A structure of type "Parámetro inválido"=>"error" is associated.
errorMsg_noCampaigns
Due to an unexpected error, the query could not be carried out.

Exit structure:

campaign.CampaignID
Campaign ID
campaign.Name
Campaign name
campaign.Status
Sending status
  • [Draft(Draft)
  • Halted|Paused(Paused)
  • Stopped(Stopped)
  • Completed(Completed)
  • Pending(Pending)
  • Sending(Sending)
  • Completed(Sent)]
Only campaigns in status Paused or Stopped can be sent
campaign.ScheduleType
Sending schedule type. [Not scheduled | Send Now | One time scheduled]
campaign.schedule.ScheduleSendDate
Sending schedule date. It´s only valid if the type is "One time scheduled"
campaign.schedule.ScheduleErrorStatus
Errors checked during the sending process. (See chart below)

** Only relevant fields are documented.

ScheduleErrorStatus:

errorMsg_remoteContentNotFound
No se ha podido recuperar el contenido remoto de tu campaña
errorMsg_campaignNotFound
La campaña ha sido eliminada y no puede recuperarse
errorMsg_administratorSuspended
La cuenta se encontraba suspendida al momendo de intentar enviar la campaña
errorMsg_administratorExhaustedQuota
Tu cuenta no tenía créditos disponibles y la operación fué detenida
errorMsg_maillistsEmpty
La lista de destinatarios utilizada no posee contactos activos

** Only relevant errors are documented.

2.Retrieve Campaign information

Service:

/campaign/load

It retrieves campaign information

Parameters:

ParameterCampaignID
MandatoryYES
TypeInteger number >0
ExplanationID of the campaign to be retrieved
ExampleCampaignID=10

Errors:

errorMsg_formValidations
One or several of the parameters entered are incorrect, missing or required. A structure of type "Parámetro inválido"=>"error" is associated.
errorMsg_campaignInvalidID
Due to an unexpected error, the query could not be carried out.
errorMsg_campaignNotFound
Campaign cannot be found
errorMsg_campaignMaillistNotFound
Associated lists cannot be found
errorMsg_campaignContentNotFound
Campaign content cannot be found
errorMsg_campaignScheduleNotFound
Campaign schedule cannot be found

Exit structure

campaign.CampaignID
Campaign ID
campaign.Name
Campaign ID
campaign.Status
Send status (Only campaigns in status Paused or Stopped can be sent)Posible values
  • [Draft(Draft)
  • Paused(Paused)
  • Stopped(Stopped)
  • Pending(Pending)
  • Pendingfor Approval(Pending for Approval)
  • Sending (Sending)
  • Completed (Completed)
Only campaigns in status Paused or Stopped can be sent
campaign.schedule.ScheduleType
Schedule type . Possible values:
  • Not scheduled(Not scheduled)
  • Send Now(Send Now)
  • One time scheduled(Scheduled)
campaign.schedule.ScheduleSendDate
Sending schedule date. It´s only valid if the type is "One time scheduled"
campaign.schedule.ScheduleErrorStatus
Errors checked during the sending process. (See chart below)

3.Create or Modify campaign information

Service:

/campaign/save

It creates or modifies campaign information. The call must be made via POST

Parameters:

ParameterCampaignID
MandatoryNO
TypeInteger number >0
ExplanationCampaign ID to be modified
ExampleCampaignID=2
ParameterCampaignName
MandatoryYES
TypeCharacter chain
ExplanationCampaign ID to be modified
ExampleCampaignName=Campaña de navidad
ParameterCampaignSubject
MandatoryNO
TypeCharacter chain
ExplanationSubject with which campaign will be sent
ExampleCampaignSubject=Feliz Navidad
ParameterMailListsIds
MandatoryNO
TypeInteger number array >0
ExplanationList IDs to which campaign will be sent.
ExampleMailListsIds[]=4
ParameterFromID
MandatoryNO
TypeInteger number >0
ExplanationAdministrator e-mail ID designated as origin of the campaign (FROM)
ExampleFromID=3
ParameterReplyToID
MandatoryNO
TypeInteger number >0
ExplanationAdministrator e-mail ID designated as reply e-mail. (ReplyTO)
ExampleReplyToID=4
ParameterTrackLinkClicks
MandatoryNO
Type0 o 1 (by default 0)
ExplanationIf the parameter is =1, all clicks made on the links will be recorded once the campaign has been sent.
ExampleTrackLinkClicks=1
ParameterTrackReads
MandatoryNO
Type0 o 1 (by default 0)
ExplanationIf the parameter is =1, every time a contact opens the e-mail it will be recorded
ExampleTrackReads=1
ParameterTrackAnalitics
MandatoryNO
Type0 o 1 (by default 0)
ExplanationIf the parameter is =1,the required parameters will be added to each link by "google analitics" to follow up the campaign.
ExampleTrackAnalitics=0
ParameterSendStateReport
MandatoryNO
Type0 o 1 (by default 0)
ExplanationIf the parameter is =1, when the campaign was sent, the owner of the acount will receive an e-mail with the status.
ExampleSendStateReport=0
ParameterScheduleCampaign
MandatoryNO
Type0 o 1 (by default 0)
ExplanationIf the parameter is =1, "Sending schedule" of the campaign must be recorded.
ExampleScheduleCampaign=1
ParameterSendDate
MandatoryNO
TypeDate with format yyyy-MM-dd HH:mm:ss
ExplanationDate in which campaign will be sent. This parameter depends on "ScheduleCampaign"
ExampleSendDate=2012-11-20 14:10:00
ParameterAddToPublicArchive
MandatoryNO
Type0 o 1 (by default 0)
ExplanationAdd campaign to "public file of campaigns"
ExampleAddToPublicArchive=1

** Only relevant fields are documented.

Errors:

errorMsg_formValidations
One or several of the parameters entered are incorrect, missing or required.
errorMsg_invalidCampaignDate
Sending date is prior to today
errorMsg_campaignIsCompletedNotSaved
The campaign you are trying to modify was already sent.
errorMsg_campaignMaillistsNotSaved
Contact lists could not be saved/assigned
errorMsg_phishing
Campaign is marked as possible fraud attempt
errorMsg_campaignContentNotSaved
Subject or parameters related to the campaign content could not be saved.
errorMsg_campaignScheduleNotSaved
"Sending schedule" could not be saved
errorMsg_campaignLoad
Campaign cannot be retrieved
errorMsg_campaignNotPost
Parameters were sent via GET and must be sent via POST
errorMsg_campaignNotFound
Una vez guardados los datos, se intenta verificar la correcta persistencia de los datos. Si no se puede encontrar la campaña se retorna este error
errorMsg_campaignMaillistNotFound
Una vez guardados los datos, se intenta verificar la correcta persistencia de los datos. Si no se pueden encontrar las listas asociadas se retorna este error
errorMsg_campaignContentNotFound
Una vez guardados los datos, se intenta verificar la correcta persistencia de los datos. Si no se puede encontrar el contenido de la campaña se retorna este error
errorMsg_campaignScheduleNotFound
Una vez guardados los datos, se intenta verificar la correcta persistencia de los datos. Si no se puede encontrar la programación de la campaña se retorna este error

Exit structure:

** It returns all input parameters and adds the following data:.

campaign.integrity.status
= 1 If the campaign contains all the necessary information to be sent
= -1
campaign.integrity.schedule
= 1 if the information regarding the sending schedule is correct and complete
= -1
campaign.integrity.status
= 1 If the campaign contains all the necessary information to be sent
= -1
campaign.integrity.subject
= 1 if it contains a subject
= -1
campaign.integrity.content
= 1 if the body of the e-mails is not empty
= -1
campaign.integrity.replyTo
= 1 If it has a reply e-mail assigned.
= -1
campaign.integrity.fromTo
= 1 If it has a sender e-mail assigned
= -1
campaign.integrity.maillist
= 1 If it has one or several lists assigned
= -1

4.Campaign preview by e-mail or browser

Service:

/campaign/preview

Campaign preview by e-mail or browser. This service supports a special type of exit format ("format") . The type "email"

Parameters:

ParameterCampaignID
MandatoryYES
TypeInteger number
ExplanationID of the campaign to be retrieved
ExampleCampaignID=10
ParameterEmail
MandatoryOnly if the format is "email"
TypeE-mail address
ExplanationRecipient of the campaign preview
ExampleEmail=j.f.fray@envialosimple.com

** Only relevant fields are documented.

Errors:

errorMsg_formValidations
One or several of the parameters entered are incorrect, missing or required. A structure of type "Parámetro inválido"=>"error" is associated.
errorMsg_campaignNotFound
Campaign cannot be found
errorMsg_remoteContentEmpty
Remote content associated to the campaign is empty
errorMsg_remoteContentNotFound
Remote content associated to the campaign could not be found.
errorMsg_campaignNotPersonalized
Tokens from custom fields cannot be replaced

Exit structure:

email.fromName
Sender e-mail name label
email.from
Sender e-mail
email.replyToName
E-mail name labelResponder a:
email.replyTo
E-mail ofResponder a:
campaign.CampaignName
Campaign name
campaign.CampaignName
Campaign name
campaign.subject
Subject of the campaign
campaign.HTML
HTML code of the campaign
campaign.plainText
Alternative plain text for clients who do not support HTML
campaign.CampaignID
Campaign identifier

5.Delete campaign

Service:

/campaign/delete

It deletes a campaign permanently

Parameters:

ParameterCampaignIds
MandatoryYES
TypeArray of Integer numbers
ExplanationIDs of campaigns to be deleted
ExampleCampaignIds[]=10&CampaignIds[]=1

Errors:

errorMsg_formValidations
One or more of the input parameters are incorrect, missing or mandatory. It´s associated to a structure of type "Invalid parameter"=>"error"
errors.notDeleted
If you are not able to delete the campaign, in the reply we will have a node "errors" with the IDs of the campaigns that were not deleted and another node "countNotDeleted" with the number of campaigns that were not deleted
Ej: errors:{notDeleted:["10","2"]},countNotDeleted: "2

If you are not able to delete the campaign, in the reply we will have a node "errors" with the IDs of the campaigns that were not deleted and another node "countNotDeleted" with the number of campaigns that were not deleted
Ej: errors:{notDeleted:["10","2"]},countNotDeleted: "2.

Ej: errors:{notDeleted:["10","2"]},countNotDeleted: "2"

Exit structure

countDeleted
Number of deleted campaigns

6.Create body of the campaign (HTML/Plain text)

Service:

/content/edit

It creates/modifies the body of the campaign e-mail

View details of the service

7.Send a campaign

Service:

/campaign/resume

Once the campaign has been created with its content, you can start sending e-mails to recipients. This method also needs to be used when restarting a paused campaign

Parameters:

ParameterCampaignID
MandatoryYES
TypeInteger number
ExplanationIdentifier of the campaign to be sent
ExampleCampaignID=10

Errors:

errorMsg_formValidations
One or more of the input parameters are incorrect, missing or mandatory. It´s associated to a structure of type "Invalid parameter"=>"error"
errorMsg_campaignNotActive
Campaign is on status "Draft" therefore, it is not ready to be sent.
errorMsg_campaignNotResumed
Campaign could not be restarted/sent
errorMsg_campaignNotScheduled
Status could not be changed
errorMsg_campaignCompleted
Campaign was sent completely. It cannot be resent.
errorMsg_maxSimultaneousCampaignLimitExceeded
More than 10 campaigns cannot be sent simultaneously

Exit structure

campaign.CampaignID
Campaign ID

8.Pause campaign

Service:

/campaign/pause

It stops the sending of a campaign. This campaign can later be resumed with a call to the service "/campaign/resume"

Parameters:

ParameterCampaignID
MandatoryYES
TypeInteger number
ExplanationIdentificador de la campaña a pausar
ExampleCampaignID=10

Errors:

errorMsg_formValidations
One or more of the entry parameters are incorrect, missing or mandatory. A structure of type "Parámetro inválido"=>"error" is associated.
errorMsg_campaignNotActive
The campaign is on status "Draft" therefore, it cannot be paused.
errorMsg_campaignAlreadyPaused
Campaign is already paused
errorMsg_campaignStoppedOrCompleted
Campaign is stopped or completed
errorMsg_campaignCompleted
Campaign has been sent completely. It cannot be paused
errorMsg_campaignNotPaused
Campaign could not be paused

Exit structure

campaign.CampaignID
Campaign ID

9.Useful implementation examples in PHP

In this example, we will :

  • 1. Create a campaign with the following characteristics:
    • 1. Name: 'Summer deal'
    • 2. Subject: 'Amazing Summer Deals!!!'
    • 3. Contact list ID: 1
    • 4. Sender e-mail ID: 21
    • 5. Reply e-mail ID: 21
    • 6. Follow links: yes
    • 7. Count open messages: yes
    • 8. Use Google Analytics: yes
    • 9. Send report after process has been completed: yes
    • 10. Add public file: yes
  • 2. Change status of sending to ACTIVE: yes
  • 3. Schedule to send now: yes
  • 4. Create e-mail content and assign it to the campaign.
  • 5. Send the campaign.

Script

textarea with the script code member.php

Script PHP Exit

New Campaign: XX

Body of the created campaign

Campaign was sent. To check progress and results of the campaign, go to the "reports" module.


<?php$baseURL = 'https://app.envialosimple.com';$apiKey = 'TU LLAVE';// Creo nueva campaña$params = array();$params['APIKey']=$apiKey;$params['CampaignName']='Promo Verano';$params['CampaignSubject']='Super Ofertas de verano!!!';$params['MailListsIds']=array('1','2');$params['FromID']='21';$params['ReplyToID']='21';$params['TrackLinkClicks']='1';$params['TrackReads']='1';$params['TrackAnalitics']='1';$params['SendStateReport']='';$params['AddToPublicArchive']='1';$params['ScheduleCampaign']='1';$params['SendNow']='1';$ch = curl_init();curl_setopt($ch, CURLOPT_URL, $baseURL.'/campaign/save/format/json');curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);curl_setopt($ch, CURLOPT_POST, 1);curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($params));$jsonResponse = curl_exec($ch);curl_close($ch);$response = json_decode($jsonResponse, true);$ok = isset($response['root']['ajaxResponse']['success']);if(!$ok){echo "Error al crear la campaña\n";print_r($response);exit;}$id = $response['root']['ajaxResponse']['campaign']['CampaignID'];$name = $response['root']['ajaxResponse']['campaign']['Name'];echo "Nueva Campaña: $id $name\n";if($response['root']['ajaxResponse']['campaign']['integrity']['status']=='1'){if($response['root']['ajaxResponse']['campaign']['integrity']['subject']=='-1'){echo "Debes asignar un Asunto.\n";}if($response['root']['ajaxResponse']['campaign']['integrity']['schedule']=='-1'){echo "Debes determinar una configuracion de envio\n";}if($response['root']['ajaxResponse']['campaign']['integrity']['content']=='-1'){echo "Debes determinar un contenido de la campaña\n";}if($response['root']['ajaxResponse']['campaign']['integrity']['replyTo']=='-1'){echo "Debes determinar un remitente 'reply to'\n";}if($response['root']['ajaxResponse']['campaign']['integrity']['fromTo']=='-1'){echo "Debes determinar un origen 'from'\n";}if($response['root']['ajaxResponse']['campaign']['integrity']['maillist']=='-1'){echo "Debes determinar una o varias listas de contactos\n";}}// Crea contenido$params = array();$params['APIKey']=$apiKey;$params['CampaignID']=$id;$params['HTML']='<h1>Super ofertas de verano!!!</h1><p>Mirá nuestros <a href="http://mitiendita.com.ar">productos</a></p> <br/> para desuscribirse click <a href="%UnSubscribe%">aquí</a>';$params['PlainText']="Super ofertas de verano!!!\n\n\tMira nustros productos en http://mitiendita.com.ar";// Asigno contenido a la campaña.$ch = curl_init();curl_setopt($ch, CURLOPT_URL, $baseURL.'/content/edit/format/json');curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);curl_setopt($ch, CURLOPT_POST, 1);curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($params));$jsonResponse = curl_exec($ch);curl_close($ch);$response = json_decode($jsonResponse, true);$ok = isset($response['root']['ajaxResponse']['success']);if(!$ok){echo "No se pudo asigar el contenido del email a la campaña\n";print_r($response);exit;}echo "Cuerpo de campaña creado\n";// Envio la campaña$params = array();$params['APIKey']=$apiKey;$params['CampaignID']=$id;$ch = curl_init();curl_setopt($ch, CURLOPT_URL, $baseURL.'/campaign/resume/format/json');curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);curl_setopt($ch, CURLOPT_POST, 1);curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($params));$jsonResponse = curl_exec($ch);curl_close($ch);$response = json_decode($jsonResponse, true);$ok = isset($response['root']['ajaxResponse']['success']);if(!$ok){echo "Error al enviar la campaña\n";print_r($response);exit;}if($ok){echo "Campaña enviada. Para ver el avance y el resultado de la campaña ver el modulo de 'reportes'\n";}?>

Módulo content

1.Create body of the campaign (HTML/Plain text)

Service:

/content/edit

It retrieves, creates or modifies the campaign e-mail body. If the service is called via GET, it retrieves record information indicated by the CampaignID parameter. If it is via POST, it creates or updates record data indicated by the CampaignID parameter.

Parameters:

ParameterCampaignID
MandatoryYES
TypeInteger number >0
ExplanationID of the campaign to be retrieved
ExampleCampaignID=10
ParameterURL
MandatoryNO
TypeURL
ExplanationAddress from where the campaign content will be obtained. The URL must be encoded as a parameter (PHP:rawurlencode). If this parameter is present, the content will be remote and HTML and PlainText parameters will be ignored.
ExampleURL=http://misitio.com/modelo.html
ParameterHTML
MandatoryNO
TypeCharacter chain
ExplanationBody of the e-mail in HTML
ExamplePlainText=mi contenido
ParameterPlainText
MandatoryNO
TypeCharacter chain
ExplanationBody of the text in plain text. Used for clients who do not support HTML
ExamplePlainText=mi contenido
ParameterRemoteUnsubscribeBlock
MandatoryNO
TypeInteger number
ExplanationIf the URL parameter is present (campagin with remote content), it´s required to customize the unsuscribe link, complete this parameter with the label %UnSubscribe% that will be replaced by the Unsubscribe link.
ExampleRemoteUnsubscribeBlock=To unsubscribe from our list do the following Click here

Note:

In the e-mail content, you will find a link to unsubscribe from contact list.

It can be provided in 2 ways:

a) If the content has been provided via URL (remote content), you must indicate in the RemoteUnsubscribeBlock parameter the link to unsubscribe.

b) If the content has been provided via HTML parameter, the parameter needs to have the unsubscribe link together with the e-mail content. Link to unsubscribe: ‹span›To unsubscribe from our list do the following‹/span› ‹a href="%UnSubscribe%" target="_blank"›Click here‹/a›

The link to unsubscribe is mandatory, if it is not present, the API will return the error "errorMsg_unSubscribeTagMissing"

Errors:

errorMsg_formValidations
One or more of the entry parameters are incorrect, missing or mandatory. A structure of type "Parámetro inválido"=>"error" is associated.
errorMsg_unSubscribeTagMissing
In the body of the e-mail, the link to unsubscribe was not found
errorMsg_contentNotSaved
Campaign content cannot be saved
errorMsg_campaignNotFound
Campaign cannot be found

Exit structure

content.CampaignID
Campaign ID
content.URL
URL of the remote content
content.PlainText
Text of the body of the campaign e-mail for clients who do not support HTML
content.HTML
HTML body of the campaign e-mail
content.IsEmpty
1 if the body of the campaign is empty. (No URL, HTML or PlainText)

** Only relevant fields are documented.

2.List templates

Service:

/template/gallery

Recupera el listado de plantilla

Parameters:

ParameterretrieveList
MandatoryNO
TypeCharacter chain
ExplanationE-mail designs of your campaigns
ExampleretrieveList=defaulTemplates
Parameteroffset
MandatoryNO
TypeInteger number
ExplanationNumber of records from which the list has to start retrieving
Exampleoffset=10
Parameterlimit
MandatoryNO
TypeInteger number
ExplanationNumber of records to retrieve
Examplelimit=10
ParameterfilterListByCategory
MandatoryNO
TypeArray for integer numbers
ExplanationGroup of search filters per general category.
ExamplefilterListByCategory[]=2
ParameterfilterListByCategory2
MandatoryNO
TypeArray for integer numbers
ExplanationGroup of search filters per color.
ExamplefilterListByCategory2[]=8

Note: Each one of the filters per category generates a search of type (OR); the combination of both filters generates a search of type (OR) AND (OR)Ej. SELECT ... WHERE ( 'filterListByCategory'=5 OR 'filterListByCategory'=7 ) AND ('filterListByCategory2'=16)

Errors:

errorMsg_formValidations
One or several of the parameters entered are incorrect, missing or required.

Exit structure

myTemplatesList.template[0].templateId
Record ID (Template)
myTemplatesList.template[0].templateTitle
Template title (If the list correspond to campaign content, it will be the title of the campaign)
myTemplatesList.template[0].templateThumbnail
Information on the thumbnail-sized screenshots of the template design. The path is relative to the domain. https://app.envialosimple.com . If the list correspond to default templates, you must add between the domain and the mentioned path the prefix mailing_templates from the template directory.. Ej. https://app.envialosimple.com/mailing_templates/119/content-t.jpg
myTemplatesList.template[0].templateThumbnailZoom
Path relative to the full-sized screenshots, if it exists, of the template design. (Instructions related to the path are identical to the thumbnail-sized ones)

** Only relevant fields are documented.

3.List template categories

Service:

/campaign/templatecategories

It retrieves category list used to group templates

list.category[]List of general categories.

list.color[]List of categories per color.

Exit structure:

list.category[]
List of general categories
list.color[]
List of categories per color
list.category[0].CategoryID
Category ID
list.category[0].NameToken
Category name
list.category[0].HasIcon
Nodes of type list.color have here a chain of characters to use as CSS selectors to identify the color

Módulo member

1.List contacts

Service:

/member/list

List all contacts from all list filtering by e-mail

Parameters:

ParameterMailListsIds
MandatoryNO
TypeArray
ExplanationGet only users from selected lists
ExampleMailListsIds[]=125
Parametercount
MandatoryNO
TypeInteger number
ExplanationMaximum number of users to be returned
Examplecount=10
Parameterabsolutepage
MandatoryNO
TypeInteger number
ExplanationRecord page "count" to be accessed .If count is equal to 10 and absolutepage is equal to 3, then, we will start viewing from contact number 31.
Exampleabsolutepage=3
Parameterfilter
MandatoryNO
TypeCharacter chain
ExplanationE-mail or part of the e-mail by which contacts are filtered
Examplefilter=nombre@dominio.com
ParameterorderBy
MandatoryNO
TypeNúmero entero Cadena de caracteres
Valores posibles:
name
id
ExplanationField by which the list will be ordered.
ExampleorderBy=name
Parameterdesc
MandatoryNO
TypeNúmero entero
Valores posibles:
0
1
ExplanationField by which the list will be ordered.
Exampledesc=1

Errors:

errorMsg_formValidations
One or more of the entry parameters are incorrect, missing or mandatory. A structure of type "Parámetro inválido"=>"error" is associated.
errorMsg_membersNotFound
Contacts could not be retrieved

Exit structure:

list.item.MemberID
Contact ID
list.item.Email
Contact e-mail
list.item.BounceType
Type of bounce [1=hard bounce|2=Soft Bounce|3=No Bounces]
list.item.MailLists.activeCount
Number of lists to which user is associated
list.item.MailLists.item.MailListID
Contact list ID
list.item.MailLists.item.SubscriptionStatus
User subscription status on the list
list.item.MailLists.item.MailListName
List name
list.item.CustomFields.item.CustomField<1..100>
Custom fields of member
list.pager.absolutepage
Page being displayed
list.pager.pagecount
Total number of pages
list.pager.totalCount
Total number of records
list.pager.rowCount
Number of records per page.
customfields
List of custom fields created by the administrator
customfields.rows.CustomFieldID
Custom field IDs
customfields.rows.Title
Custom field titles
criteria.filter
Filter entered as parameter

** Only relevant fields are explained or listed

2.Create or modify contact information

Service:

/member/edit

It retrieves, creates or modifies contact information.

This service behaves in different ways depending on how we make the call. If we do it via GET and pass the MemberID parameter, it will try to retrieve the contact information. If we use POST, it will try to modify or create the contact depending on whether the MemberID parameter is defined or not.

Parameters:

ParameterMemberID
MandatoryNO
TypeInteger number
ExplanationContact ID to be modified. Only necessary if you want to retrieve the information or modify the contact.
ExampleMemberID=2
ParameterMailListID
MandatoryNO
TypeInteger number
ExplanationList to which contact will be initially subscribed to. Only one list must be assigned
ExampleMailListID=4
ParameterEmail
MandatoryNO
TypeCharacter chain
ExplanationE-mail address to be subscribed
ExampleEmail=rogelio@donweb.com
ParameterCustomField<1..100>
MandatoryNO
TypeArreglo de cadena
ExplanationValues for each Custom field- The numeric part of the parameter is the custom field ID "CustomFieldID"
ExampleCustomField1=rogelio&CustomField3=hombre&CustomField5=argentina

Errors:

errorMsg_formValidations
One or more of the parameters entered are incorrect, missing or mandatory
errorMsg_memberNotFound
User to be modified was not found. It can only appear during a modification
errorMsg_memberNotSaved
Due to an unexpected error, contact could not be saved.
errorMsg_memberBanned
Contact could not be subscribed to list since the e-mail is forbidden

Exit structure:

member.MemberID
Contact ID
member.Email
Contact e-mail
member.CustomFields
member.CustomFields.item.CustomField<1..100>

Custom fields of member

** Only relevant fields are explained and listed.

3.Change contact status (Subscribe, unsubscribe, Disassociate, etc)

Service:

/member/changestaus

It modifies the status of one or more contacts associated to one or more lists.

Parameters:

ParameterMemberIds
MandatoryYES
TypeArray for integer numbers
ExplanationAll contact IDs to be modified
ExampleMemberIds[]=1&MemberIds[]=2
ParameterMailListsIds
MandatoryYES
TypeArray for integer numbers
ExplanationAll contact lists to be used to operate
ExampleMailListsIds[]=4&MailListsIds[]=9
ParameterSubscriptionStatus
MandatoryYES
TypeCharacter chain
ExplanationIndica el estado que se quiere asignar a los contactos.
Valores posibles:PendingOptIn (pendiente de confirmación)
Subscribed (suscripto)
Unsubscribed (desuscripto)
Deleted (remover de la lista)
ExampleSubscriptionStatus=Subscribed

Errors:

errorMsg_formValidations
One or several of the parameters entered are incorrect, missing or required.
invalidMaillist
ID lists of invalid contact lists. Do not exist
invalidMember
ID lists of invalid contacts. Do not exist
subscribed
ID list of contacts subscribed successfully. This parameter is only present if there was an error and "notSubscribed" is present.
notSubscribed
ID list of valid contacts non-subscribed
countNotSubscribed
Number of non-subscribed contacts (notSubscribed invalidMember)

Exit structure:

countChanged=number
Number of contacts that were modified successfully
changestatus
changestatus.detail
changestatus.detail.changed
array that has a key for each MemberID whose value is an array of each MaillistID for which the status has been modified

Example:

changestatus: {
            detail: {
            changed: {
                2:["4","9"],
                1:["4","9"]
                     }
                    }
                SubscriptionStatus: "Subscribed"
                  }
            countChanged: 2

4.Unsubscribe contacts per e-mail

Service:

/member/unsubscribebyemail

It removes one or more contacts from one or several lists filtering by e-mail

Parameters:

Parameteremails
MandatoryYES
TypeArray of chains
ExplanationAll contact e-mail addresses to be unsubscribed.
Exampleemails[]=toto@tritolo.com&emails[]=juena@gmail.com
ParameterMailListsIds
MandatoryYES
TypeArray for integer numbers
ExplanationAll contact lists to which MembersIds are to be unsubscribed.
ExampleMailListsIds[]=4&MailListsIds[]=9
Parameterban
MandatoryNO
TypeInteger[0|1]
ExplanationCreate an exclusion rule per e-mail of the e-mail parameter
Exampleban=1

Errors:

errorMsg_formValidations
One or several of the parameters entered are incorrect, missing or required.

Exit structure:

countUnsubscribed
Number of users successfully subscribed
notUnsubscribed
Array of e-mails of valid contacts Non unsubscribed
countNotUnsubscribed
Number of contacts non unsubscribed (notUnsubscribed invalidMember)

5.Useful implementation examples in PHP:

In this example, we will :

Create contact with e-mail=juanperez@gmail.com, Name=Juan, last name=Perez and SUBSCRIBE to list with ID=1 .

Subscribe contact to list with ID=2.

Unsubscribe from list 1 the contact created in step 1

Look for contact created in step 1 within list 2

Script

TEAXTAREA with the code of the script member.php

Script PHP Exit

Nuevo Contacto: 19962 - juanperez@gmail.com: Juan Perez

User successfully subscribed to list 2

User successfully unsubscribed from list 1

El usuario 19962 - juanperez@gmail.com (Juan Perez) esta suscripto a la lista 2


<?php$baseURL = 'https://app.envialosimple.com';$apiKey = 'KEY';//Create a new contact in the list 1$params = array();$params['APIKey']=$apiKey;$params['MailListID']=1;$params['Email']='juanperez@gmail.com';$params['CustomField1']='Juan';$params['CustomField2']='Perez';$ch = curl_init();curl_setopt($ch, CURLOPT_URL, $baseURL.'/member/edit/format/json');curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);curl_setopt($ch, CURLOPT_POST, 1);curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($params));$jsonResponse = curl_exec($ch);curl_close($ch);$response = json_decode($jsonResponse, true);$id = $response['root']['ajaxResponse']['member']['MemberID'];$email = $response['root']['ajaxResponse']['member']['Email'];$nombre = $response['root']['ajaxResponse']['member']['CustomFields']['item']['CustomField1']['Values']['Option'][0]['Value'];$apellido = $response['root']['ajaxResponse']['member']['CustomFields']['item']['CustomField2']['Values']['Option'][0]['Value'];echo "Nuevo Contacto: $id - $email: $nombre $apellido \n";//Subscribe contact to list with ID=2$params = array();$params['APIKey']=$apiKey;$params['MailListsIds']=array(2);$params['MemberIds']=array($id);$ch = curl_init();curl_setopt($ch, CURLOPT_URL, $baseURL.'/member/changestatus/SubscriptionStatus/Subscribed/format/json');curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);curl_setopt($ch, CURLOPT_POST, 1);curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($params));$jsonResponse = curl_exec($ch);curl_close($ch);$response = json_decode($jsonResponse, true);$exito = $response['root']['ajaxResponse']['success'];$count = $response['root']['ajaxResponse']['countSubscribed'];if($exito && $count=1){echo "Contacto suscripto correctamente a la lista 2\n";}else{echo "No se pudo suscribir correctamente a la lista 2\n";print_r($response);exit;}//Unsubscribe contact from list 1$params = array();$params['APIKey']=$apiKey;$params['MailListsIds']=array(1);$params['MemberIds']=array($id);$ch = curl_init();curl_setopt($ch, CURLOPT_URL, $baseURL.'/member/changestatus/SubscriptionStatus/Unsubscribed/format/json');curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);curl_setopt($ch, CURLOPT_POST, 1);curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($params));$jsonResponse = curl_exec($ch);curl_close($ch);$response = json_decode($jsonResponse, true);$exito = $response['root']['ajaxResponse']['success'];$count = $response['root']['ajaxResponse']['countUnsubscribed'];if($exito && $count=1){echo "User successfully unsubscribed from list 1\n";}else{echo "No se pudo desuscribir correctamente de la lista 1\n";print_r($response);exit;}//Look for contact created in step 1 within list 2$params = array();$params['APIKey']=$apiKey;$params['MailListID']=2;$params['filter']='juanperez';$ch = curl_init();curl_setopt($ch, CURLOPT_URL, $baseURL.'/member/listbymaillist/format/json?'.http_build_query($params));curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);$jsonResponse = curl_exec($ch);curl_close($ch);$response = json_decode($jsonResponse, true);foreach ($response['root']['ajaxResponse']['list']['item'] as $item){$tmpid = $item['MemberID'];$tmpemail = $item['Email'];$tmpnombre = $item['CustomFields']['item']['CustomField1']['Values']['Option'][0]['Value'];$tmpapellido = $item['CustomFields']['item']['CustomField2']['Values']['Option'][0]['Value'];echo "El Contacto $tmpid - $tmpemail ($tmpnombre $tmpapellido) esta suscripto a la lista 2\n";}?>

Módulo mailist

This module groups administration services of contact lists.

1.Display contact lists

Service:

/maillist/list

It displays all contact lists

Parameters:

Parametercount
MandatoryNO
TypeInteger number
ExplanationNumber of maximum records per page.
Examplecount=10
Parameterabsolutepage
MandatoryNO
TypeInteger number
ExplanationRecord page "count" that you want to go to. If count is equal to 10 and absolutepage is equal to 3, then, we will start viewing from record number 31
Exampleabsolutepage=3
Parameterfilter
MandatoryNO
TypeCharacter chain
ExplanationType part or the entire name by which records are filtered
Examplefilter=Summer deal
ParameterorderBy
MandatoryNO
TypePossible character chain:
  • name (list name)
  • activememberscount (number of active members)
  • memberscount (Total number of members)
ExplanationField by which the list will be ordered
ExampleorderBy=name
Parameterdesc
MandatoryNO
Type[1|0]
ExplanationIt determines whether the order of the list is ascending (0) or descending (1)
Exampledesc=1

Errors:

errorMsg_formValidations
One or several of the parameters entered are incorrect, missing or required.
errorMsg_noMaillist
Contact lists could not be retrieved

Exit structure:

list.item.MailListID
Contact list ID
list.item.Name
Contact list name
list.item.MemberCount
Total number of contacts (Subscribed or unsubscribed)
list.item.ActiveMembersCount
Total number of contacts subscribed or pending subscription
SubscriptionType
[Opt-in (Subscription confirmation is required.) | Free (Subscription without confirmation)]

2.Create or modify contact list

Service:

/maillist/edit

It retrieves, creates and edits the attributes of a contact list. If the service is called via GET, it retrieves the information of the requested list. If it is via POST, it creates or updates (if the parameter MaillistID is entered) the name of the contact list.

Parameters:

ParameterMailListID
MandatoryNO
TypeInteger number
ExplanationContact list ID
ExampleMailListID=2
ParameterMailListName
MandatoryYes (Only by POST)
TypeInteger number
ExplanationCharacter chain
ExampleMailListName=My contact list

Errors:

errorMsg_formValidations
One or several of the parameters entered are incorrect, missing or required.
errorMsg_maillistNotFound
Requested list was not found
errorMsg_maillistNotEdited
Contact list could not be edited

Exit structure:

maillist.MailListID
Contact list ID
maillist.MailListName
Contact list name

** Only relevant fields are documented.

Módulo report

This module groups report services. It is very useful to know the status or statistics of your campaign..

1.Real-time monitoring

Service:

/report/livetrack

It checks the progress of campaign e-mails sent.

Parameters:

ParameterCampaignID
MandatoryYES
TypeInteger number
ExplanationCampaign ID
ExampleCampaignID=2
ParameterStatisticsID
MandatoryNO
TypeInteger number
ExplanationSending ID, if this attribute is not present, the last message sent will be used (Compatibility with previous version)
ExampleStatisticsID=4

Errors:

errorMsg_formValidations
One or several of the parameters entered are incorrect, missing or required.
errorMsg_campaignNotFound
The campaign was not found

Exit structure:

campaign.schedule.ScheduleStatus
Sending progress. Possible values [Pending|Preparing|Sending|Paused|Halted|Completed]
report.detailsOfSend.TotalSent
Total e-mails sent
report.detailsOfSend.TotalDelivered
Total e-mails sent except for hard and soft bounces
report.detailsOfSend.TotalRecipients
Total number of contacts to which the message has to be sent.

** Only relevant fields are documented.

2.General report

Service:

/report/livetrack

It informs details of a campaign and all e-mails possibly sent. (When sending multiple e-mails of a campaign, they are kept by compatibility with a previous system).

Parameters:

ParameterCampaignID
MandatoryYES
TypeInteger number
ExplanationCampaign ID
ExampleCampaignID=2
ParameterStatisticsID
MandatoryNO
TypeInteger number
ExplanationSending ID, if this attribute is not present, the last message sent will be used (Compatibility with previous version)
ExampleStatisticsID=4

Errors:

errorMsg_formValidations
One or several of the parameters entered are incorrect, missing or required.
errorMsg_campaignNotFound
The campaign was not found
errorMsg_track
An unspecified error occurred while trying to get the report

Exit structure:

report.sendFilesDetail
Points to a service that generates a file with a detail of e-mails sent
report.detailsOfSend.TotalSent
Points to a service that generates a file with a detail of e-mails sent
report.detailsOfSend.TotalDelivered
Total e-mails sent except for hard and soft bounces
report.detailsOfSend.TotalRecipients
Total number of contacts to which the message has to be sent.
report.list.item.*
Specific attributes of each e-mail sent. In general, there must be only 1 e-mail
report.campaign.Name
Campaign name
report.campaign.publicURL
URL to share campaign reports

** Only relevant fields are documented.

3.Reports distributed through out the time

Service:

/report/trackintime

It reports e-mails read (unique and total) and clicks distributed through out the time. It is recommended to use Flot (http://code.google.com/p/flot/ to view this report

Parameters:

ParameterCampaignID
MandatoryYES
TypeInteger number
ExplanationCampaign ID
ExampleCampaignID=2
ParameterStatisticsID
MandatoryNO
TypeInteger number
ExplanationSending ID, if this attribute is not present, the last message sent will be used (Compatibility with previous version)
ExampleStatisticsID=4

Errors:

errorMsg_formValidations
One or several of the parameters entered are incorrect, missing or required.
errorMsg_campaignNotFound
The campaign was not found

Exit structure:

report.chart.UniqueReads
Pairs [tick, value] of unique reads
report.chart.Reads
Pairs [tick, value] of unique reads
report.chart.LinksClicks
Pairs [tick, value] of clicks on links
report.chart.Ticks
Pairs [tick, label]
report.campaign.CampaignID
Campaign ID
report.campaign.StatisticsID
Sending ID

** Only relevant fields are documented.

4.Summarized report

Service:

/report/trackgraph

Summarized report with e-mails read, bounced, of-subscriptions, delivered, etc. Flot is recommended to view this report (http://code.google.com/p/flot/)

Parameters:

ParameterCampaignID
MandatoryYES
TypeInteger number
ExplanationCampaign ID
ExampleCampaignID=2
ParameterStatisticsID
MandatoryNO
TypeInteger number
ExplanationSending ID, if this attribute is not present, the last message sent will be used (Compatibility with previous version)
ExampleStatisticsID=4

Errors:

errorMsg_formValidations
One or several of the parameters entered are incorrect, missing or required.
errorMsg_trackGraph
An unspecified error occurred while trying to get the report

Exit structure:

trackGraph.graph.Opened
Total e-mails opened
trackGraph.graph.UniqueOpened
Total e-mails unique opened
trackGraph.graph.Clicks
Total clicks
trackGraph.graph.Bounces
Total bounces
trackGraph.graph.Unsubscribed
Total unsubscription e-mails
trackGraph.graph.TotalDelivered
Total e-mails sent
trackGraph.graph.TotalRecipients
Total Recipients
trackGraph.graph.StatisticsID
Sending ID

** Only relevant fields are documented.

5.Export reports of e-mails read and clicks

Service:

/report/exportreads | /report/exportlinks

It generates a CSV file with the information of e-mails read (/report/exportreads) and clicks (/report/exportlinks) of a campaign. Once the CSV file is generated, the service "/download/export?FileToken=" has to be called to download it.

Parameters:

ParameterCampaignID
MandatoryYES
TypeInteger number
ExplanationCampaign ID
ExampleCampaignID=2
ParameterStatisticsID
MandatoryNO
TypeInteger number
ExplanationSending ID, if this attribute is not present, the last message sent will be used (Compatibility with previous version)
ExampleStatisticsID=4

Errors:

errorMsg_formValidations
One or several of the parameters entered are incorrect, missing or required.
errorMsg_campaignNotFound
The campaign was not found
errorMsg_exportDirNotWritable
File cannot be written to the hard disk.
errorMsg_reads
Unspecified error

Exit structure:

report.campaign.Name
Campaign name
report.campaign.CampaignID
Campaign ID
report.campaign.StatisticsID
Sending ID
report.totalCount
Total of records processed.
report.FileName
Name of the generated file (to be used with /download/export)

** Only relevant fields are documented.

If you are interested in getting more reports or making suggestions on new reports, please get in touch with us!. https://administracion.donweb.com/clientes/index.php?modulo=soporte&archivo=asistente

Módulo administratoremail

This module groups administration services of e-mail lists used as sender of the campaigns and subscriptions forms.

1.Real-time monitoring

Service:

/administratoremail/list

List e-mail addresses

Parameters:

Parametercount
MandatoryNO
TypeInteger number
ExplanationNumber of maximum records per page.
Examplecount=10
Parameterabsolutepage
MandatoryNO
TypeInteger number
ExplanationRecord page "count" that you want to go to. If count is equal to 10 and absolutepage is equal to 3, then, we will start viewing from record number 31
Exampleabsolutepage=3

Errors:

errorMsg_formValidations
One or several of the parameters entered are incorrect, missing or required.

Exit structure:

list.item.EmailID
Record ID
list.item.EmailAddress
E-mail address
list.item.Name
Label or name associated to the e-mail address
list.item.DkimPubKey
Public key of the DKIM signature (only if it is configured)
list.item.DkimPrivKey
Private key of the DKIM Signature (only if it is configured)

** Only relevant fields are documented.

2.Create or modify e-mail address information

Service:

/administratoremail/edit

It retrieves, creates or edits the attributes of an e-mail address. If the service is called via GET, it retrieves the information of the requested record. If the service is called via POST, it creates or updates (Id the parameter EmailID is entered) the record data.

Parameters:

ParameterEmailID
MandatoryNO
TypeInteger number
ExplanationRecord ID
ExampleEmailID=2
ParameterName
MandatoryYes (Only by POST)
TypeCharacter chain
ExplanationLabel or name associated to the e-mail address
ExampleName=My name
ParameterEmailAddress
MandatoryYes (Only by POST)
TypeCharacter chain
ExplanationE-mail address
ExampleEmailAddress=minombre@midominio.com
ParameterDkimPubKey
MandatoryNO
TypeCharacter chain
ExplanationPublic key of the DKIM signature
ExampleDkimPubKey=BEGIN PUBLIC KEY ######### END PUBLIC KEY
ParameterDkimPrivKey
MandatoryNO
TypeCharacter chain
ExplanationPrivate key of the DKIM signature
ExampleDkimPrivKey=BEGIN RSA PRIVATE
KEY#######END RSA PRIVATE
KEY

Errors:

errorMsg_formValidations
Uno o varios de los parámetros de entrada son incorrectos, faltan o son requerido
errorMsg_administratorEmailNotFound
Requested record was not found

Exit structure:

email.EmailID
Record ID
email.Name
Label or name associated to the e-mail address
email.EmailAddress
E-mail address
email.DkimPubKey
Public key of the DKIM signature
email.DkimPrivKey
Private key of the DKIM signature
email.DNSRecord.name
Host DNS name (Used for the DKIM configuration)
email.DNSRecord.value
Record value (Used for the DKIM configuration)
email.DNSRecord.type
Type of record of the DNS Zone. (Used for the DKIM configuration)
email.dkimIsValid
It indicates whether the DKIM configuration is valid

** Only relevant fields are documented.

3.Automatic generation of DKIM Keys

Service:

/administratoremail/genKey

Generates automatically a couple of keys to use in the DKIM configuration

Parameters:

Exit structure:

openssl.public
Public key of the DKIM signature
openssl.private
Private key of the DKIM signature

** Only relevant fields are documented.

4.Check DKIM configuration

Service:

/administratoremail/testdkim

Check whether the DKIM signature configuration and the DNS information are correct and updated.

Parameters:

ParameterEmailID
MandatoryNO
TypeInteger number
ExplanationRecord ID
ExampleEmailID=2

Errors:

errorMsg_formValidations
One or several of the parameters entered are incorrect, missing or required.
errorMsg_administratorEmailNotFound
Requested record was not found

Exit structure:

email.EmailID
Record ID
email.DNSRecord.name
Host DNS name (Used for the DKIM configuration)
email.DNSRecord.value
Record value (Used for the DKIM configuration)
email.dkimIsValid
It indicates whether the DKIM configuration is valid

** Only relevant fields are documented.

5.Delete e-mail address

Service:

/administratoremail/delete

It deletes logically an e-mail address, the record will no be displayed in the lists but the system will still be able to use it to guarantee that other campaigns using the address work fine.

Parameters:

ParameterEmailIds
MandatoryYES
TypeArray for integer Numbers
ExplanationRecord IDs that you wish to delete.
ExampleEmailIds[]=2&EmailIds[]=5

Errors:

errorMsg_formValidations
One or several of the parameters entered are incorrect, missing or required.
errors.notDeleted
Record ID array that were not able to be deleted

Exit structure:

countDeleted
Number of records successfully deleted
countNotDeleted
Number of records that were not able to be deleted

Módulo administrator

This module groups administration services of e-mail lists used as sender of the campaigns and subscriptions forms.

1.Status of the administrator account

Service:

/administrator/status

This service provides information related to the administrator account status such as: available credits, programmed tasks, import/export/purge processes of members from contact lists

Parameters:

Exit structure:

credits.availableCredits
Number of available credits the administrator has.
jobs.item[]
Array that has all tasks, carried out or in process, in the background

Each one of the elements of the array has the following data:

jobs.item[].BatchJobID
Task identifier
jobs.item[].UserID
Administrator identifier
jobs.item[].Type
Tipo de tarea:
  • BatchMaillistImport / import:
    Import members to list
  • BatchSegment:
    Create segmented list
  • BatchMaillistOptimize :
    Optimize list
  • purge:
    Purge Members from lists
  • export:
    Export lists
jobs.item[].Params
Enter parameters for the task
jobs.item[].Response
Reply of the task carried out or in progress
jobs.item[].Progress
Progress status from 0 to 100
jobs.item[].Status
Description of the task current status: for example
jobs.item[].Status
Description of the task current status: for example.completed
jobs.item[].ErrorCode
Error code, only if it exists.
jobs.item[].CreationDate
Creation date of the task
jobs.item[].LastUpdate
Last update of the task
jobs.item[].DeleteDate
Deletion date of the task

Módulo customfield

This module groups administration services of custom fields used for contact information and for subscription forms..

1.Listar campos personalizados

Service:

/customfield/list

List custom fields that have been configured

Parameters:

Parametercount
MandatoryNO
TypeInteger number
ExplanationNumber of maximum records per page.
Examplecount=10
Parameterabsolutepage
MandatoryNO
TypeInteger number
ExplanationRecord page "count" that you want to go to. If count is equal to 10 and absolutepage is equal to 3, then, we will start viewing from record number 31
Exampleabsolutepage=3
Parameterfilter
MandatoryNO
TypeCharacter chain
ExplanationType part or the entire name by which records are filtered
Examplefilter=Summer deal
ParameterorderBy
MandatoryNO
Type[name|id]
ExplanationField by which the list will be ordered
ExampleorderBy=Id
Parameterdesc
MandatoryNO
Type[1|0]
ExplanationIt determines whether the order of the list is ascending (0) or descending (1)
Exampledesc=1

Errors:

errorMsg_formValidations
One or several of the parameters entered are incorrect, missing or required.

Exit structure:

list.item.CustomFieldID
Record ID (custom field)
list.item.FieldType
Type of custom field:
'Text field' Text field
'Password field' Password field
'Hidden field' Hidden field
'Notice' Informative block
'Text area' Multiline text field
'Check box' Multiple selection options
'Radio button' Single selection options
'List' Multiple selection list
'Drop list' Single selection list
list.item.Validation
Type of data validation accepted by the field:
'Do not Apply' Do not validate (Option by default)
'Numeric Only' Accept only digits (no spaces)
'Alpha Only' Accept only letters and spaces
'Alpha Numeric Only' Accept only letters, numbers and spaces
'Email Format Check' Accept only e-mail addresses
'Custom' Custom (It requires a custom regular expression validation to be configured)
list.item.ValidationCustomRegExp
Custom regular expression used to validate field data
list.item.IsMultipleSelect
It indicates whether multiple values are accepted
list.item.Values.Option
Array of values for the field

2.Create or Modify the information of a custom field

Service:

/customfield/edit

It retrieves, creates or modifies the attributes of a custom field. If the service is called via GET, it retrieves the information of the requested record. If the service is called via POST, it creates or updates (if the CustomFieldID is entered) record data.

Parameters:

ParameterCustomFieldID
MandatoryNO
TypeInteger number
ExplanationRecord ID
ExampleEmailID=2
ParameterTitle
MandatoryYes (Only by POST)
TypeCharacter chain
ExplanationLabel or name of the custom field
ExampleTitle=Color
ParameterFieldType
MandatoryYes (Only by POST)
TypeCharacter chain
ExplanationType of custom field
ExampleFieldType=List
ParameterValidation
MandatoryNO
TypeCharacter chain
ExplanationType of data validation accepted by the field
ExampleValidation=Custom
ParameterValidationCustomRegExp
MandatorySi (Solo si el parámetro Validation es de tipo Custom)
TypeCharacter chain
ExplanationCustom regular expression used to validate field data
ExampleValidationCustomRegExp=/^[a-zA-Z0-9]*$/
ParameterDefaultValue
MandatoryNO
TypeCharacter chain
ExplanationDefault values for the field (used only in fields Text field, Password field, Text area, Notice y Hidden field)
ExampleDefaultValue=0800My Phone
ParameterItemsNames
MandatoryNO
TypeArray
ExplanationLabel list of field options (used only in fields of type List, Drop List, Radio Button and Check box) [View Note]
ExampleItemsNames[]=Rojo&ItemsNames[]=Blanco
ParameterItemsValues
MandatoryNO
TypeArray
ExplanationList of values of the field options (used only in field types List, Drop list, Radio button y Check box) [View note]
ExampleItemsValues[]=red&ItemsValues[]=white
ParameterItemsSelectedValues
MandatoryNO
TypeArray
ExplanationList of the field options marked as selected (used only in field types List, Drop list, Radio buttony Check box)
ExampleItemsSelectedValues[]=white
ParameterItemsIsMultipleSelect
MandatoryNO
TypeInteger [1|0]
ExplanationIt indicates whether the field accepts multiple values
ExampleItemsIsMultipleSelect=1

Note: Parameters ItemsNames and ItemsValues are related since both keys have corresponding keys. Eg. ItemsNames[5 has the label of the option whose value is indicated in ItemsValues[5]

Errors:

errorMsg_formValidations
One or several of the parameters entered are incorrect, missing or required.
errorMsg_customfieldNotFound
Requested record was not found

Exit structure:

customField.CustomFieldID
Record ID (custom field)
customField.Title
Label/ field name
customField.FieldType
Type of custom field
customField.Validation
Type of data validation accepted by the field
customField.ValidationCustomRegExp
Custom regular expression used to validate field data
customField.IsMultipleSelect
It indicates whether multiple values are accepted
customField.Values.Option
Array of values for the field

** Only relevant fields are documented.

3.Delete custom field

Service:

/customfield/delete

It deletes a custom field permanently, the record will not be available to be used.

Parameters:

ParameterCustomFieldIds
MandatoryYES
TypeArray for integer Numbers
ExplanationRecord IDs that you wish to delete.
ExampleCustomFieldIds[]=2&CustomFieldIds[]=5

Errors:

errorMsg_formValidations
One or several of the parameters entered are incorrect, missing or required.
errors.notDeleted
Record ID array that were not able to be deleted

Exit structure:

countDeleted
Number of records successfully deleted
countNotDeleted
Number of records that were not able to be deleted


Mensaje enviado con éxito
Ocurrió un error al enviar el mensaje.
NUESTROS
TELEFONOS
FORMULARIO
DE CONTACTO
CHATEA CON
UN ASESOR
CONVERSA CON
NOSOTROS