The power of integrating
EnvíaloSimple
+ HTTP API
+ Documentation
= Easy integration
API EnvíaloSimple
Our new API will allow you to integrate EnvíaloSimple with all your applications through simple URL calls, offering you countless functionalities, grouped by modules to facilitate their use and implementation.
You will be able to send your email marketing campaigns; create, modify, and delete contacts, contact lists, and campaigns; consult statistics and reports, and many more functionalities so you can integrate it with your applications.
Postman
If you use Postman, we provide the collection of methods for you to import into your environment.
Variable Setup
Our collection of methods requires the parameterization of the following Postman variables for proper operation:
| Name | Value |
|---|---|
| url | https://api.esmsv.com |
| token | I6Ik9UZzFNakUyTVRVME9USXpNVGM0TUE9PSIsIntyuHVlIjoiMm9y… |
Authentication
To use the new API, you must have an API key. For this, you must log into your account, go to Settings > API Key, and generate a new key.
When using the services, the authorization method must be present in the header where you must send this key (token).
Example:
curl --location --request GET 'https://api.esmsv.com/v1/administrator/profile' --header 'Authorization: eyJpdiI6Ik9UZzFNakUyTVRVME9USXpNVGM0TUE9PSIsInZhbHVlIjoiMm9yaGZPYzZqNjVwL1haakw5SlovakNKcEZCeWpGaBcDEfGhIjklMNopqMD0iLCJtYWMiOiJhODVmNDgxZWUxYWoPu2Jktm1MjU0ZDhmNmUzMjA3NDliOGQwYWJkZWFlMjFkNDA4NmNiODRhMjYxIn0='
Clarification: If you were already using the previous API and had created a key, you will not be able to use the same one; you must create a new one.
Response
All responses will have two sections: status and code.
Additionally, depending on the type of service, other sections will be added, which will be detailed in each of them.
| Name | Description |
|---|---|
| status | This will show the value “ok” when the process executes correctly and “error” when there is an error. |
| code | This will show a success message when the process executes correctly or a detail when there are errors. |
Errors
There are two types of errors: input data validation errors (CODE 422) and those specific to each service (CODE 400). Below are the validation errors (CODE 422) that are common to all services:
| Code | Description |
|---|---|
| is_not_accepted | Value not accepted. |
| invalid_url | Invalid URL. |
| invalid_date | Incorrect date. |
| invalid_alpha_format | The value must contain only letters. |
| invalid_alpha_dash_format | The value must contain only letters, numbers, dashes, and underscores. |
| invalid_alpha_num_format | The value must contain only letters and numbers. |
| invalid_array_format | The value must be an array. |
| attached | This field has already been attached. |
| before_date | The value must be a previous date. |
| before_or_equal_date | The value must be a previous or equal date. |
| invalid_between_elements | Invalid number of elements. |
| invalid_between_size_file | Invalid file size. |
| invalid_between_number | Invalid value. |
| invalid_between_characters | Invalid number of characters. |
| invalid_boolean | The value must be true or false. |
| invalid_value_confirmed | Invalid confirmed value. |
| invalid_date_format | Invalid date format. |
| invalid_date_equal | Incorrect date. |
| invalid_value_different | The value must be different. |
| invalid_value_digits | Invalid number of digits. |
| invalid_value_digits_between | Invalid number of digits. |
| invalid_image_dimensions | Invalid image dimensions. |
| value_duplicate | Duplicate value. |
| invalid_email_format | The email format is incorrect. |
| invalid_velue_ends_with | The entered value is incorrect. |
| not_exists | The field is invalid. |
| is_not_file | The field must be a file. |
| not_empty | The field is required. |
| invalid_gt_elements | Invalid number of elements. |
| invalid_gt_size_file | Invalid file size. |
| invalid_gt_numeric | Incorrect value. |
| invalid_gt_characters | Invalid number of characters. |
| invalid_gte_elements | Invalid number of elements. |
| invalid_gte_size_file | Invalid file size. |
| invalid_gte_numeric | Invalid value. |
| invalid_gte_characters | Invalid number of characters. |
| invalid_image | The field must be an image. |
| invalid_value_in | Invalid value. |
| invalid_value_in_array | Invalid value. |
| invalid_value_integer | The field must be an integer. |
| invalid_value_ip | The field must be a valid IP address. |
| invalid_ipv4_format | The field must be a valid IPv4 address. |
| invalid_ipv6_format | The field must be a valid IPv6 address. |
| invalid_json_format | The field must be a valid JSON string. |
| invalid_lt_elements | Invalid number of elements. |
| invalid_lt_size_file | Invalid file size. |
| invalid_lt_numeric | Invalid value. |
| invalid_lt_characters | Invalid number of characters. |
| invalid_lte_elements | Invalid number of elements. |
| invalid_lte_size_file | Invalid file size. |
| invalid_lte_numeric | Invalid value. |
| invalid_lte_characters | Invalid number of characters. |
| invalid_max_elements | Invalid number of elements. |
| invalid_max_size_file | Invalid file size. |
| invalid_max_numeric | Invalid value. |
| invalid_max_characters | Invalid number of characters. |
| invalid_mimes | Invalid file format. |
| invalid_mimetypes | Invalid file format. |
| invalid_min_elements | Invalid number of elements. |
| invalid_min_size_file | Invalid file size. |
| invalid_min_numeric | Invalid value. |
| invalid_min_characters | Invalid number of characters. |
| multiple_of | Invalid value. |
| invalid_format | Invalid field format. |
| only_numeric | The field must be numeric. |
| invalid_password | Password is incorrect. |
| is_not_present | The field must be present. |
| prohibited | The field is prohibited. |
| prohibited_if | The field is prohibited. |
| prohibited_unless | The field is prohibited. |
| relatable | The field cannot be associated with this resource. |
| required | The field is required. |
| is_not_same_that | The fields must match. |
| invalid_count_elements | Invalid number of elements. |
| invalid_size_file | Invalid file size. |
| invalid_size_number | Invalid value. |
| invalid_count_characters | Invalid number of characters. |
| invalid_value | Invalid value. |
| only_characters | The field must be a string of characters. |
| invalid_timezone | The field must be a valid timezone. |
| is_used | The field has already been registered. |
| error_upload_file | Error uploading the file. |
| invalid_url_format | The URL-type format of the field is invalid. |
| invalid_uuid_format | The field must be a valid UUID. |
Account 6
This module groups services to manage your account settings and view your activity summary.
Description
Returns administrator account information.
Output structure:
| Field | Description |
|---|---|
| id | Account ID |
| name | First and last name |
| username | Username |
| Email address | |
| timeZone | Time zone. See possible values at: Get time zones |
| country | Country. See possible values at: Get countries |
| subscription.Type | Plan type. Possible values: Prepaid –> Prepaid Monthly –> Monthly |
| subscription.Quota | Plan send quota. Only shown for Plan type = Monthly |
| subscription.TermBegin | Start date. Only shown for Plan type = Monthly |
| subscription.TermEnd | End date. Only shown for Plan type = Monthly |
| subscription.Credits | Available credits |
| created | Account creation date |
| publicArchivesURL | URL to access the public campaign archive |
Description
Allows editing the account settings.
Body
| Key | Value | Description |
|---|---|---|
| name | Juan Pérez | First and last name. Required. |
| account@example.com | Email. Required. | |
| timezone | -10800 | Time Zone. Required. See possible values at: Get time zones. |
| country | ar | Country. Required. See possible values at: Get countries. |
Description
Returns administrator account statistics.
Output structure:
| Field | Description |
|---|---|
| TotalSent | Total sends in the last month |
| AvgMonthlyTotalSent | Average sends in the last six months |
| campaigns.Count | Total campaigns created |
| campaigns.Sent | Total sends in campaigns |
| autoresponders.Count | Total automations created |
| autoresponders.Sent | Total sends in automations |
| maillists.Count | Number of active lists |
| activeMembers.Count | Number of active contacts |
| reads.Count | Total opens in campaigns and automations (total opens) |
| clicks.Count | Total clicks in campaigns and automations (total clicks) |
Description
Returns a list of possible time zones for account configuration.
Output structure:
| Field | Description |
|---|---|
| label | Description of the time zone |
| value | Time zone code. It will be used in Edit general account settings |
Description
Returns a list of possible countries for account configuration.
Output structure:
| Field | Description |
|---|---|
| label | Country description |
| value | Country code. It will be used in Edit general account settings |
Description
Returns a list of the account’s domains.
Output structure:
| Field | Description |
|---|---|
| id | Domain ID |
| domain | Domain name |
| status | Domain status. Possible values: NotVerified (Not verified) / Pending (Pending verification) / Verified (Verified but not authenticated) / Authenticated (Authenticated) |
Body
| Key | Value | Description |
|---|---|---|
| name | yourdomain.com | Filter by domain name |
| status | Authenticated | Filter by domain status. Possible values: Pending (Pending verification) / Verified (Verified but not authenticated) / NotVerified (Not verified) / Authenticated (Authenticated). |
| limit | 10 | Number of records to display per page. Maximum: 100. |
| page | 1 | Page number to display. |
| orderBy | name | Criteria to sort domains. Possible values: name/id. Default: id. |
| order | asc | Sort type. Possible values: asc/desc. Default: desc. |
Automations 15
This module will allow you to perform all management associated with automations from creation to activation.
Description
Returns a list of all automations. They can be filtered by various fields: name, status, and creation date.
Output structure:
| Field | Description |
|---|---|
| id | Automation ID |
| name | Automation title |
| created | Automation creation date |
| schedule_type | Sending type. Possible values: AutoresponderInmediate -> As soon as the event is detected AutoresponderDeferred-> Scheduled |
| days_of_the_week | Days of the week it can be sent |
| moment | Time when the automation will be sent. Possible values: after -> After before -> Before onDay -> On the day Only shown if Sending type = Scheduled |
| days | Number of days. Only shown if Sending type = Scheduled and Moment = Before or After. |
| hour | Sending hour. Only shown if Sending type = Scheduled |
| event | Trigger event. See possible values at: Get automation trigger events. |
| status | Automation status. Possible values: Draft -> Draft Paused -> Paused Stopped -> Stopped PendingforApproval -> Pending approval Sending -> Active |
Body
| Key | Value | Description |
|---|---|---|
| filter | test | Filter by name or part of the automation name. |
| status | Sending | Filter by automation status. Possible values: Draft / Sending / Paused / PendingForApproval / Stopped |
| createDateFrom | 2023-04-23 | Filter by creation date from. Format: YYYY-MM-DD. |
| createDateTo | 2023-05-28 | Filter by creation date to. Format: YYYY-MM-DD. |
| limit | 10 | Number of records to display per page. Maximum: 100. |
| page | 1 | Page number to display. |
| orderBy | name | Criterion to order the automations. Possible values: name/id. Default: id. |
| order | desc | Order type. Possible values: asc/desc. Default: desc. |
Description
Returns the details of an automation. Note that depending on the trigger event and the type of sending, different fields are displayed.
Output structure:
| Field | Description |
|---|---|
| id | Automation ID |
| name | Automation title |
| subject | Subject |
| previewText | Preview text |
| fromAlias | Sender name |
| fromEmail | From |
| replyEmail | Reply to |
| event | Trigger event. See possible values at: Get automation trigger events. |
| maillists | Contact list(s) (ID and Name). Only shown for Events = Subscription to a list, Unsubscription from a list, and Annual event |
| idCustomField | Custom field code of type Annual event configured. Only shown for Trigger event = Annual event |
| relCampaign | Campaign ID associated with the automation. Only shown for Events = Open, Click on any link, Click on specific link, and No clicks on a link |
| url | URL of the campaign associated with the automation. Only shown for Events = Click on specific link and No clicks on a link |
| daysNoClick | Number of days without click. Only shown for Event = No clicks on a link |
| created | Automation creation date |
| schedule_type | Type of sending. Possible values: AutoresponderInmediate -> As soon as the event is detected AutoresponderDeferred-> Scheduled |
| moment | Moment when the automation will be sent. Possible values: after -> After before -> Before onDay -> On the day Only shown if Type of sending = Scheduled |
| days | Number of days. Only shown if Type of sending = Scheduled and Moment = Before or After. |
| hour | Sending time. Only shown if Type of sending = Scheduled |
| daysOfTheWeek | Days of the week it can be sent |
| status | Automation status. Possible values: Draft -> Draft Paused -> Paused Stopped -> Stopped PendingforApproval -> Pending approval Sending -> Active |
| content | Automation content in HTML |
| trackLinkClicks | Track links |
| trackReads | Count opens |
| trackAnalitics | Link with Google Analytics |
Errors:
| Code | Description |
|---|---|
| errorMsg_automationNotFound | No automation exists with the provided ID. |
URL Variables
| Key | Value | Description |
|---|---|---|
| automation_id | 449 | Automation Id. Required |
Body
Description
Allows creating a new automation. Only the Title and the Trigger Event are required.
Output structure:
| Field | Description |
|---|---|
| id | ID of the created automation |
| name | Title of the automation |
Errors:
| Code | Description |
|---|---|
| errorMsg_relCampaignNotActive | The reference campaign is in draft. |
| errorMsg_relCampaignNotFound | No campaign exists with the provided ID. |
| errorMsg_relCampaignRequired | It is required to provide the reference Campaign when a Link is provided. |
| errorMsg_mailListsIdsNotValid | No list exists with the provided ID. |
| errorMsg_specificUrlInvalid | The provided link does not exist. |
| errorMsg_idCFNotFound | No custom field of Type = Annual Event exists with the provided ID. |
| errorMsg_relCampaignIsNotAllowedByEvent | Providing a reference Campaign is not allowed for the specified Event. |
| errorMsg_specificUrlIsNotAllowedByEvent | Providing a specific Link is not allowed for the specified Event. |
| errorMsg_idCFIsNotAllowedByEvent | Providing a specific Date is not allowed for the specified Event. |
| errorMsg_mailListsIdsIsNotAllowedByEvent | Providing Contact Lists is not allowed for the specified Event. |
| errorMsg_daysNoClickIsNotAllowedByEvent | Providing Days without click is not allowed for the specified Event. |
| errorMsg_contentOrcontentUrlOrtemplateId | Only one of the fields can be entered: HTML Content or URL or Template. |
| errorMsg_TemplateIDNotFound | No template exists with the provided ID. |
Body
| Key | Value | Description |
|---|---|---|
| name | Father's Day Promotion | Automation title. Required. |
| subject | Hello %Member:CustomField1% %Member:CustomField2% | Automation subject. You can include custom fields using the “Custom field code” obtained from the “Get custom field details” service. |
| previewText | Preview text | Preview text. |
| fromAlias | Company S.A. | Sender name. |
| fromEmail | administrator@example.com | Email address from which the automation will be sent. Required only if the “fromAlias” field is filled. |
| replyEmail | administrator@example.com | Email address for “Reply to”. |
| content | %Member:CustomField1% %Member:CustomField2% Check out the promotions we have for you! | Email content in HTML. You can include custom fields using the “Custom field code” obtained from the “Get custom field details” service. |
| contentUrl | http://google.com.ar | Generate HTML content of the automation from a URL. |
| templateId | 65bceb74cf2a51360090a4b6 | Template ID. |
| event | click_ones | Trigger event. See possible values at: Get trigger events. Required. |
| relCampaign | 230 | Reference campaign ID. Required if a specific link is reported. |
| specificUrl | http://www.google.com | Specific link of the reference campaign. See possible values at: Get links of a campaign. |
| daysNoClick | 3 | Days without click. |
| mailListsIds[] | 36 | Array of contact list IDs. |
| idCF | 12 | Custom field ID corresponding to specific date. See possible values at: Get custom fields collection. |
| trackLinkClicks | 1 | Track links. Possible values: 0/1. Default is 1. |
| trackReads | 0 | Count opens. Possible values: 0/1. Default is 1. |
| trackAnalitics | 0 | Link with Google Analytics. Possible values: 0/1. Default is 1. |
Description
Allows editing all fields of an existing automation, taking into account the following considerations:
- Only automations in Draft, Paused, or Stopped status can be modified.
- If you want to clear the data, the parameters must be sent with a blank value.
- When modifying a Stopped or Paused automation, it will automatically become Draft.
Errors:
| Code | Description |
|---|---|
| errorMsg_automationNotFound | No automation exists with the provided ID. |
| errorMsg_nameIsRequired | The automation Title cannot be left blank. |
| errorMsg_contentOrcontentUrlOrtemplateId | Only one of the fields can be entered: HTML Content or URL or Template. |
| errorMsg_TemplateIDNotFound | No template exists with the provided ID. |
| errorMsg_automationSending | It is not possible to modify an Active automation. |
| errorMsg_automationPendingForApproval | It is not possible to modify an automation under review. |
| errorMsg_relCampaignNotActive | The referenced campaign is in draft. |
| errorMsg_relCampaignNotFound | No campaign exists with the provided ID. |
| errorMsg_relCampaignRequired | It is required to provide the reference Campaign when a Link is provided. |
| errorMsg_eventIsRequired | It is required to provide a Trigger Event when Campaign or Link or List or Specific Date or Days without click is provided. |
| errorMsg_mailListsIdsNotValid | No list exists with the provided ID. |
| errorMsg_specificUrlInvalid | The provided link does not exist. |
| errorMsg_idCFNotFound | No custom field of Type = Annual Event exists with the provided ID. |
| errorMsg_relCampaignIsNotAllowedByEvent | Providing a reference Campaign is not allowed for the specified Event. |
| errorMsg_specificUrlIsNotAllowedByEvent | Providing a specific Link is not allowed for the specified Event. |
| errorMsg_idCFIsNotAllowedByEvent | Providing a Specific Date is not allowed for the specified Event. |
| errorMsg_mailListsIdsIsNotAllowedByEvent | Providing Contact Lists is not allowed for the specified Event. |
| errorMsg_daysNoClickIsNotAllowedByEvent | Providing Days without click is not allowed for the specified Event. |
Body
| Key | Value | Description |
|---|---|---|
| id | 577 | Automation Id. Required. |
| name | Test edit automation | Automation title. |
| subject | Hello %Member:CustomField1% %Member:CustomField2% | Automation subject. You can include custom fields using the “Custom field code” obtained from the “Get custom field details” service. |
| previewText | Preview text | Preview text. |
| fromAlias | Company S.A. | Sender’s name. |
| fromEmail | company@example.com | Email address from which the campaign will be sent. Required only if the “fromAlias” field is filled. |
| replyEmail | email@example.com | Email address for “Reply to”. |
| content | %Member:CustomField1% %Member:CustomField2% Check out the promotions we have for you! | Email content in HTML. You can include custom fields using the “Custom field code” obtained from the “Get custom field details” service. |
| contentUrl | http://google.com.ar | Generate automation HTML content from a URL. |
| templateId | 65bceb74cf2a51360090a4b6 | Template ID. |
| event | annual_event | Trigger event. See possible values at: Get trigger events. Required. |
| relCampaign | 230 | Reference campaign ID. Required if a specific link is provided. |
| specificUrl | http://google.com | Specific link of the referral campaign. See possible values at: Get links of a campaign. |
| daysNoClick | 3 | Days without click. |
| mailListsIds[] | 36 | Array of contact list IDs. |
| idCF | 3 | Custom field ID corresponding to a specific date. See possible values at: Get collection of custom fields. |
| trackLinkClicks | 0 | Track links. Possible values: 0/1. Default is 1. |
| trackReads | 0 | Count opens. Possible values: 0/1. Default is 1. |
| trackAnalitics | 0 | Link with Google Analytics. Possible values: 0/1. Default is 1. |
Description
Allows previewing automations by email.
A preview of the automation will be sent to the specified emails. If there are custom fields in the content: it takes the value from a contact in the assigned list or any random contact if there is no list.
Errors:
| Code | Description |
|---|---|
| errorMsg_automationNotFound | No automation exists with the provided ID. |
| errorMsg_warnPreviewLimit | Maximum daily send limit exceeded. |
| errorMsg_notAllowed | You are not allowed to send previews. |
Body
| Key | Value | Description |
|---|---|---|
| id | 590 | Automation ID. Required. |
| emails[] | email@example.com | Array of emails. Required. Maximum: 5. |
Description
Allows previewing automations via browser.
Returns an HTML of the automation to preview it in any browser. If there are custom fields in the content: it takes the value of the specified contact, otherwise it takes some contact from the assigned list, otherwise any random contact if there is no list.
Errors:
| Code | Description |
|---|---|
| errorMsg_automationNotFound | No automation exists with the provided ID. |
Body
| Key | Value | Description |
|---|---|---|
| id | 590 | Automation Id. Required. |
| email@example.com | Email used to fill in the custom fields included in the automation. |
Description
Allows generating a thumbnail of the automation content.
Errors:
| Code | Description |
|---|---|
| errorMsg_automationNotFound | No automation exists with the provided ID. |
Body
| Key | Value | Description |
|---|---|---|
| id | 578 | Automation Id. Required. |
| width | 300 | Image width. Required. Minimum: 200, maximum: 600. |
| height | 600 | Image height. Required. Minimum: 200, maximum: 600. |
Description
Checks if the automation meets all the conditions to be activated. The response will include three additional sections:
- canSend indicating whether the automation is in a condition to be activated.
- errors showing a detailed list of reasons why it cannot be activated, if any.
- warnings showing a detailed list of warnings that, while not preventing the activation of the automation, indicate areas for improvement, if any.
Errors:
| Code | Description |
|---|---|
| errorMsg_automationNotFound | No automation exists with the provided ID. |
| errorMsg_automationIntegrityFail-subject | The subject field is required. |
| errorMsg_automationIntegrityFail-replyTo | The replyTo field is required. |
| errorMsg_automationIntegrityFail-fromToName | The fromToName field is required. |
| errorMsg_automationIntegrityFail-fromTo | The fromTo field is required. |
| errorMsg_automationIntegrityFail-content | The automation has no content. |
| errorMsg_campaignSending | The automation is active. |
| errorMsg_campaignPendingForApproval | The automation is pending approval. |
| errorMsg_senderDomainNotVerified | The domain is not verified. |
| errorMsg_relCampaignNotFound | No active campaign exists with the provided ID. |
| errorMsg_mailListsIdsNotValid | No list exists with the provided ID. |
| errorMsg_noListSelected | A list must be provided. |
| errorMsg_invalidCampaignSelected | A campaign must be provided. |
| errorMsg_invalidUrl | A URL must be provided. |
| errorMsg_invalidCustomField | A specific date must be provided. |
| errorMsg_invalidDaysNoClick | Days without clicks must be provided. |
| errorMsg_contactListFilter | You do not have permission to activate automations. |
| errorMsg_spamRateErrorThreshold | The automation did not pass the SPAM check. |
| errorMsg_invalidMaillistsSelected | One of the lists associated with the automation does not exist. |
Warnings:
| Code | Description |
|---|---|
| errorMsg_campaignIntegrityFail-subjectShort | The subject field is short. |
| errorMsg_campaignIntegrityFail-subjectLong | The subject field is long. |
| errorMsg_spamRateWarningThreshold | The automation passed the SPAM check, but you can improve the result. |
| errorMsg_senderDomainNotAuthenticated | Domain not authenticated. |
| errorMsg_senderDmarcAllowedDomain | It is recommended to use your own domains to maintain a good reputation and improve your delivery capability. |
Body
| Key | Value | Description |
|---|---|---|
| id | 221 | Automation Id. Required. |
Description
Returns a list with all the links of a campaign for the creation and/or editing of automations whose trigger event requires the campaign URL (Events = Click on specific link and No clicks on a link)
Output structure:
| Field | Description |
|---|---|
| originalLink | Link to use in the automation |
Errors:
| Code | Description |
|---|---|
| errorMsg_campaignNotFound | No campaign exists with the provided ID or it is in draft status. |
Body
| Key | Value | Description |
|---|---|---|
| id | 1 | Campaign ID. Required. |
Description
Returns a list with the possible trigger Events for the creation and/or editing of automations.
Detail of the values:
Below is a description of the current values:
| Value | Description |
|---|---|
| opener_campaign | Opening of a campaign |
| click_any | Click on any link |
| click_one | Click on a specific link |
| no_click_one | No click within a specific time period |
| subscription | Subscription to a contact list |
| unsubscription | Unsubscription from a contact list |
| annual_event | Annual event |
Body
Description
Allows activating a draft, paused, or stopped automation.
Output structure:
| Field | Description |
|---|---|
| id | ID of the activated automation |
| status | Pending |
Errors:
| Code | Description |
|---|---|
| errorMsg_automationNotFound | No automation exists with the provided ID. |
| errorMsg_momentNotValid | The selected option in When to send for the automation event is not allowed. |
| errorMsg_automationIntegrityFail-subject | The subject field must be provided. |
| errorMsg_automationIntegrityFail-replyTo | The replyTo field must be provided. |
| errorMsg_automationIntegrityFail-fromToName | The fromToName field must be provided. |
| errorMsg_automationIntegrityFail-fromTo | The fromTo field must be provided. |
| errorMsg_automationIntegrityFail-content | The automation has no content. |
| errorMsg_campaignSending | The automation is active. |
| errorMsg_campaignPendingForApproval | The automation is pending approval. |
| errorMsg_senderDomainNotVerified | The domain is not verified. |
| errorMsg_relCampaignNotFound | No active campaign exists with the provided ID. |
| errorMsg_mailListsIdsNotValid | No list exists with the provided ID. |
| errorMsg_noListSelected | A list must be provided. |
| errorMsg_invalidCampaignSelected | A campaign must be provided. |
| errorMsg_invalidUrl | A URL must be provided. |
| errorMsg_invalidCustomField | A specific date must be provided. |
| errorMsg_invalidDaysNoClick | Days without clicks must be provided. |
| errorMsg_contactListFilter | You do not have permission to activate automations. |
| errorMsg_spamRateErrorThreshold | The automation did not pass the SPAM check. |
| errorMsg_invalidMaillistsSelected | One of the lists associated with the automation does not exist. |
Body
| Key | Value | Description |
|---|---|---|
| id | 590 | Automation Id. Required. |
| interval | 3 | Number of days after the event. Required. If interval = 0, it will be sent as soon as we detect the event; otherwise, it will be sent at a scheduled time. |
| moment | after | When to send. Possible values: before (before the event) | onDay (on the day of the event) | after (after the event). Required only if Number of days > 0. |
| time | 12 | Time it will be sent. Required only if interval > 0. |
| timeMinute | 15 | Minutes it will be sent. Required only if Number of days > 0. |
| days[] | 1 | Which days of the week it can be sent. Possible values: 0 (Sunday) | 1 (Monday) | 2 (Tuesday) | 3 (Wednesday) | 4 (Thursday) | 5 (Friday) | 6 (Saturday). Required. |
Description
Allows deleting one or multiple automations at once, considering that:
- If you want to delete a single automation, the id must be passed as a parameter.
- If you want to delete multiple automations, an array of Ids must be passed as a parameter. If some of the specified automations do not exist, they will be shown in the response under automationsNotFound.
Errors:
| Code | Description |
|---|---|
| errorMsg_automationNotFound | No automation exists with the provided ID. |
| invalid_max_elements | A maximum of 100 records can be deleted. Only for multiple deletions. |
Body
| Key | Value | Description |
|---|---|---|
| id | 470 | Id of automation to delete. Only one required: id (for deleting one automation) or array of ids (for deleting multiple automations). |
| ids[] | 6 | Array of automation Ids to delete. Maximum 100. Only one required: id (for deleting one automation) or array of ids (for deleting multiple automations). |
Description
Allows pausing an active automation.
Output structure:
| Field | Description |
|---|---|
| id | ID of the paused automation. |
| status | Paused |
Errors:
| Code | Description |
|---|---|
| errorMsg_automationNotFound | No automation exists with the provided ID. |
| errorMsg_automationNotActive | The automation is in draft. |
| errorMsg_automationPaused | The automation is already paused. |
| errorMsg_automationStopped | The automation is stopped. |
Body
| Key | Value | Description |
|---|---|---|
| id | 457 | Id of automation. Required. |
Description
Allows resuming a stopped or paused automation.
Output structure:
| Field | Description |
|---|---|
| id | ID of the resumed automation |
| status | Pending |
Errors:
| Code | Description |
|---|---|
| errorMsg_automationNotFound | No automation exists with the provided ID. |
| errorMsg_automationSending | The automation is active. |
| errorMsg_automationPendingForApproval | The automation is pending approval. |
| errorMsg_automationNotPausedOrStopped | The automation is in draft. |
Body
| Key | Value | Description |
|---|---|---|
| id | 457 | Automation Id. Required. |
Description
Allows duplicating an automation.
Output structure:
| Field | Description |
|---|---|
| id | ID of the new automation |
| name | Name of the new automation |
Errors:
| Code | Description |
|---|---|
| errorMsg_automationNotFound | No automation exists with the provided ID. |
URL Variables
| Key | Value | Description |
|---|---|---|
| automation_id | 590 | Automation Id. Required. |
Campaigns 15
This module will allow you to manage everything related to campaigns from creation to sending.
Description
Returns a list of all campaigns. They can be filtered by various fields: name, status, send type, campaign type, creation date, and send date.
Output structure:
| Field | Description |
|---|---|
| id | Campaign ID |
| name | Campaign title |
| type | Campaign type. Possible values: Quick Campaign -> Regular A/B Campaign -> A/B Test |
| created | Campaign creation date |
| type_send | Send type. Possible values: Send Now -> Send now One time scheduled -> Scheduled Not scheduled -> Not scheduled |
| status | Campaign status. Possible values: Draft -> Draft Paused -> Paused Stopped -> Stopped PendingforApproval -> Pending approval Sending -> Sending or Scheduled Completed -> Sent |
| recipients_count | Number of recipients |
| schedule_send_date | Campaign scheduled date Only for campaigns with Send type = Scheduled |
| start_date | Send start date |
| finish_date | Send end date |
Body
| Key | Value | Description |
|---|---|---|
| filter | Promo | Filter by campaign name or part of the campaign name. |
| status | Draft | Filter by campaign status. Possible values: Draft / Completed / Sending / Paused / PendingForApproval / Stopped |
| typeSend | sendNow | Filter by send type. Possible values: sendNow / scheduled. |
| createDateFrom | 2021-05-01 | Filter by creation date from. Format: YYYY-MM-DD. |
| createDateTo | 2021-05-28 | Filter by creation date to. Format: YYYY-MM-DD. |
| sendDateFrom | 2021-05-01 | Filter by send date from. Format: YYYY-MM-DD. |
| sendDateTo | 2021-05-28 | Filter by send date to. Format: YYYY-MM-DD. |
| limit | 10 | Number of records to show per page. Maximum: 100. |
| page | 1 | Page number to display. |
| orderBy | name | Criteria for ordering campaigns. Possible values: name/id. Default: id. |
| order | asc | Type of ordering. Possible values: asc/desc. Default: desc. |
| typeAB | 0 | Type of campaign. Possible values: 1 (A/B Test) and 0 (Regular). |
Description
Returns the details of a campaign. Keep in mind that:
For campaigns that are forwards, the original campaign and the type of forward will also be shown.
For campaigns that have automatic forwards configured, the type of forward, number of days, and schedule will also be shown.
For campaigns of Type = Test A/B, the data of each subject is added in subjects. The current subject remains for campaigns of Type = Regular.
Output structure:
| Field | Description |
|---|---|
| id | Campaign ID |
| name | Campaign title |
| created | Campaign creation date |
| subject | Subject |
| previewText | Preview text |
| fromAlias | Sender name |
| fromEmail | From |
| replyEmail | Reply to |
| type | Campaign type. Possible values: Quick Campaign -> Regular A/B Campaign -> Test A/B |
| subjects.partition | Subject type. Possible values: A -> Subject A B -> Subject B |
| subjects.subject | Subject |
| subjects.percentage | Subject percentage |
| maillists.id | Contact list ID |
| maillists.name | Contact list name |
| segments.id | Segment ID |
| segments.name | Segment name |
| recipients_count | Total number of campaign recipients |
| type_send | Send type. Possible values: Send Now -> Send now One time scheduled -> Scheduled Not scheduled -> Not scheduled |
| schedule_send_date | Campaign scheduled date Only for campaigns with Send type = Scheduled |
| start_date | Send start date |
| finish_date | Send end date |
| trackLinkClicks | Track links |
| trackReads | Count opens |
| trackAnalitics | Link with Google Analytics |
| sendReport | Send report |
| publicArchive | Add to public archive |
| workspace | How the content was created. Possible values: designer -> Visual editor expertCoder -> Programmer mode externalUrl -> URL mode |
| content | Campaign content in HTML |
| status | Campaign status. Possible values: Draft -> Draft Paused -> Paused Stopped -> Stopped PendingforApproval -> Pending approval Sending -> Sending or Scheduled Completed -> Sent |
| resend.ofCampaign | Campaign from which it is forwarded. Only shown for campaigns that are forwards of others. |
| resend.type | Forward type. Possible values: 1 -> To contacts who did not open the campaign 2 -> To contacts who did not click on the content 3 -> To contacts who had soft bounces 4 -> Again to all contacts |
| resend.days | Days for forwarding. Only shown for campaigns with automatic forwards configured. |
| resend.hours | Forwarding hour. Only shown for campaigns with automatic forwards configured. |
| resend.mins | Forwarding minutes. Only shown for campaigns with automatic forwards configured. |
Errors:
| Code | Description |
|---|---|
| errorMsg_campaignNotFound | No campaign exists with the provided ID. |
URL Variables
| Key | Value | Description |
|---|---|---|
| campaing_id | 12 | Campaign Id. Required. |
Body
Description
Allows creating a new campaign. Only the Title is required.
Output structure:
| Field | Description |
|---|---|
| id | ID of the created campaign |
| name | Title of the campaign |
Errors:
| Code | Description |
|---|---|
| errorMsg_mailListsIdsOrSegmentId | Only one of the fields can be entered: List(s) or Segments. |
| errorMsg_contentOrcontentUrlOrtemplateId | Only one of the fields can be entered: HTML Content or Url or Template. |
| errorMsg_TemplateIDNotFound | No template exists with the provided ID. |
| subject.not_required_on_ab_campaign | For campaigns Type = Test A/B, you cannot send subject. You must send an array of subjects. |
| subjects.only_on_ab_campaign | For campaigns Type = regular, you cannot send the subjects array. You must send only subject. |
| subjects.invalid_count_elements | For campaigns Type = Test A/B, you must send both subjects. |
| subjects.invalid_subjects_percentage | For campaigns Type = Test A/B, the sum of the percentages must be 100. |
Body
| Key | Value | Description |
|---|---|---|
| name | Father's Day Promotions | Campaign title. Required. |
| subject | Hello %Member:CustomField1% %Member:CustomField2% | Campaign subject. You can include custom fields using the “Custom field code” obtained from the “Get custom field details” service. |
| previewText | Text for preview | Preview text. |
| fromAlias | Company S.A. | Sender’s name. |
| fromEmail | administrator@example.com | Email address from which the campaign will be sent. Required only if the “fromAlias” field is filled. |
| replyEmail | administrator@example.com | Email address for “Reply to”. |
| mailListsIds[] | 1 | Array of contact list Ids. |
| segmentId | 19 | Segment Id. |
| content | %Member:CustomField1% %Member:CustomField2% Check out the promotions we have for you! | Email content in Html. You can include custom fields using the “Custom field code” obtained from the “Get details of a custom field” service. |
| contentUrl | http://google.com.ar | Generate campaign html content from a url. |
| templateId | 65983f41755d4e4c00e21007 | Template Id. |
| trackLinkClicks | 1 | Track links. Possible values: 0/1. Default is 1. |
| trackReads | 0 | Count opens. Possible values: 0/1. Default is 1. |
| trackAnalitics | 0 | Link with Google Analytics. Possible values: 0/1. Default is 1. |
| sendReport | 0 | Send report. Possible values: 0/1. Default is 1. |
| publicArchive | 1 | Add to public archive. Possible values: 0/1. Default is 0. |
| typeAB | 1 | Campaign type. Possible values: 1 (A/B Test) and 0 (Regular). Default: 0 (Regular). |
| subjects[0][subject] | Subject Test A | Subject A. If sent, both subjects and their percentages must be included. |
| subjects[0][percentage] | 50 | Subject A percentage. If sent, both subjects and their percentages must be included. |
| subjects[1][subject] | Test Subject B | Subject B. If sent, both subjects and their percentages must be included. |
| subjects[1][percentage] | 50 | Subject B percentage. If sent, both subjects and their percentages must be included. |
Description
Allows editing all fields of an existing campaign, taking into account the following considerations:
Only campaigns in Draft or Paused status can be modified.
If you want to clear the data, the parameters must be sent with a blank value.
When modifying a Paused campaign, it will automatically be set to Draft.
If any of the specified lists do not exist, they will be shown in the response under mailListsNotFound and will not be assigned to the campaign.
If the specified segment does not exist, it will be shown in the response under segmentNotFound and will not be assigned to the campaign.
The campaign Type cannot be modified.
Errors:
| Code | Description |
|---|---|
| errorMsg_campaignNotFound | No campaign exists with the provided ID. |
| errorMsg_mailListsIdsOrSegmentId | Only one of the fields can be entered: List(s) or Segments. |
| errorMsg_contentOrcontentUrlOrtemplateId | Only one of the fields can be entered: HTML Content or URL or Template. |
| errorMsg_TemplateIDNotFound | No template exists with the provided ID. |
| errorMsg_campaignPaused | The campaign is paused. |
| errorMsg_campaignSending | The campaign is sending or scheduled. |
| errorMsg_campaignPendingForApprova | The campaign is pending approval. |
| errorMsg_campaignCompleted | The campaign has been sent. |
| subject.not_required_on_ab_campaign | For campaigns Type = Test A/B, you cannot send subject. You must send an array of subjects. |
| subjects.only_on_ab_campaign | For campaigns Type = regular, you cannot send the subjects array. You must send only subject. |
| subjects.invalid_count_elements | For campaigns Type = Test A/B, you must send both subjects. |
| subjects.invalid_subjects_percentage | For campaigns Type = Test A/B, the sum of the percentages must be 100. |
Body
| Key | Value | Description |
|---|---|---|
| id | 4 | Campaign ID. Required. |
| name | Test edit campaign | Campaign name. |
| subject | Hello %Member:CustomField1% %Member:CustomField2% | Campaign subject. You can include custom fields using the “Custom field code” obtained from the “Get custom field details” service. |
| previewText | Preview text | Preview text. |
| fromAlias | Company S.A. | Sender name. |
| fromEmail | company@example.com | Email address from which the campaign will be sent. Required only if the “fromAlias” field is filled. |
| replyEmail | email@example.com | Reply-to email address. |
| mailListsIds[] | 2 | Array of contact list IDs. |
| segmentId | 1 | Segment ID. |
| content | %Member:CustomField1% %Member:CustomField2% Check out the promotions we have for you! | Email content in HTML. You can include custom fields using the “Custom field code” obtained from the “Get custom field details” service. |
| contentUrl | http://google.com.ar | Generate campaign HTML content from a URL. |
| templateId | 65bceb74cf2a51360090a4b6 | Template ID. |
| trackLinkClicks | 0 | Follow links. Possible values: 0/1. Default is 1. |
| trackReads | 0 | Count opens. Possible values: 0/1. Default is 1. |
| trackAnalitics | 0 | Link with Google Analytics. Possible values: 0/1. Default is 1. |
| sendReport | 0 | Send report. Possible values: 0/1. Default is 1. |
| publicArchive | 1 | Add to public archive. Possible values: 0/1. Default is 0. |
| subjects[0][subject] | Subject Test A | Subject A. If sent, both subjects and their percentages must be included. |
| subjects[0][percentage] | 50 | Percentage subject A. If sent, both subjects and their percentages must be included. |
| subjects[1][subject] | Subject Test B | Subject B. If sent, both subjects and their percentages must be included. |
| subjects[1][percentage] | 50 | Percentage subject B. If sent, both subjects and their percentages must be included. |
Description
Allows previewing email campaigns.
A preview of the campaign will be sent to the specified emails. If you have custom fields in the content: it takes the value from a contact in the assigned list or any random user if there is no list.
Errors:
| Code | Description |
|---|---|
| errorMsg_campaignNotFound | No campaign exists with the provided ID. |
| errorMsg_warnPreviewLimit | Maximum daily send limit exceeded. |
| errorMsg_notAllowed | You are not allowed to send previews. |
Body
| Key | Value | Description |
|---|---|---|
| id | 1 | Campaign ID. Required. |
| emails[] | email@example.com | Array of emails. Required. Maximum: 5. |
| subject | A | Subject to display. Possible values: A / B. Should only be sent for campaigns Type = Test A/B. Default: A. |
Description
Allows previewing campaigns by browser.
Returns an HTML of the campaign to preview it in any browser. If it has custom fields in the content: it takes the value of the indicated contact, otherwise it takes some contact from the assigned list, otherwise any random user if there is no list.
Errors:
| Code | Description |
|---|---|
| errorMsg_campaignNotFound | No campaign exists with the provided ID. |
Body
| Key | Value | Description |
|---|---|---|
| id | 1 | Campaign ID. Required. |
| email@example.com | Email used to fill in the custom fields included in the campaign. If this data is not sent and the campaign has custom fields, they will be filled with random contact data. |
Description
Checks if the campaign meets all the conditions to be sent. The response will include three additional sections:
- canSend indicating whether the campaign is in a condition to be sent or not.
- errors showing a detailed list of reasons why the campaign cannot be sent, if any.
- warnings showing a detailed list of warnings that, while not preventing the campaign from being sent, indicate areas for improvement, if any.
Errors:
| Code | Description |
|---|---|
| errorMsg_campaignNotFound | No campaign exists with the provided ID. |
| errorMsg_campaignIntegrityFail-subject | The subject field must be completed. |
| errorMsg_campaignIntegrityFail-replyTo | The replyTo field must be completed. |
| errorMsg_campaignIntegrityFail-fromToName | The fromToName field must be completed. |
| errorMsg_campaignIntegrityFail-fromTo | The fromTo field must be completed. |
| errorMsg_campaignIntegrityFail-content | The campaign has no content. |
| errorMsg_noListNoSegmentSelected | It is necessary to associate an email list or a segment. |
| errorMsg_campaignPendingForApproval | The campaign is pending approval. |
| errorMsg_campaignCompleted | The campaign has been sent. |
| errorMsg_maxSimultaneousCampaignLimitExceeded | The maximum limit of simultaneously sending campaigns has been reached. |
| errorMsg_senderDomainNotVerified | The domain is not verified. |
| errorMsg_noContactsInMailLists | One of the lists has no contacts. |
| errorMsg_noContactsInSegments | The segment has no contacts. |
| errorMsg_contactListFilter | You do not have permission to send campaigns. |
| errorMsg_spamRateErrorThreshold | The campaign did not pass the SPAM check. |
| errorMsg_invalidMaillistsSelected | One of the lists associated with the campaign does not exist. |
Warnings:
| Code | Description |
|---|---|
| errorMsg_campaignIntegrityFail-subjectShort | The subject field is short. |
| errorMsg_campaignIntegrityFail-subjectLong | The subject field is long. |
| errorMsg_spamRateWarningThreshold | The campaign passed the SPAM check, but you can improve the result. |
| errorMsg_senderDomainNotAuthenticated | Domain not authenticated. |
| errorMsg_senderDmarcAllowedDomain | It is recommended to use your own domains to maintain a good reputation and improve your delivery capability. |
Body
| Key | Value | Description |
|---|---|---|
| id | 3 | Campaign ID. Required. |
Description
Allows sending a campaign that is in draft or stopped, considering that:
- If the campaign is in draft, the Send Now field must always be indicated.
- If the campaign is stopped, if the Send Now field is indicated, it will take the indicated value; otherwise, it will resume with the values already configured.
Additionally, an automatic resend can be scheduled.
Output structure:
| Field | Description |
|---|---|
| id | ID of the sent campaign |
| status | Pending |
Errors:
| Code | Description |
|---|---|
| errorMsg_campaignPaused | The campaign is paused. |
| errorMsg_campaignSending | The campaign is sending or scheduled. |
| errorMsg_campaignPendingForApproval | The campaign is pending approval. |
| errorMsg_campaignCompleted | The campaign has been sent. |
| errorMsg_campaignNotFound | No campaign exists with the provided ID. |
| errorMsg_campaignIntegrityFail-subject | The subject field must be completed. |
| errorMsg_campaignIntegrityFail-replyTo | The replyTo field must be completed. |
| errorMsg_campaignIntegrityFail-fromToName | The fromToName field must be completed. |
| errorMsg_campaignIntegrityFail-fromTo | The fromTo field must be completed. |
| errorMsg_campaignIntegrityFail-content | The campaign has no content. |
| errorMsg_noListNoSegmentSelected | It is necessary to associate an email list or a segment. |
| errorMsg_maxSimultaneousCampaignLimitExceeded | The maximum limit of simultaneously sending campaigns has been reached. |
| errorMsg_senderDomainNotVerified | The domain is not verified. |
| errorMsg_noContactsInMailLists | Some of the lists have no contacts. |
| errorMsg_noContactsInSegments | The segment has no contacts. |
| errorMsg_contactListFilter | You do not have permission to send campaigns. |
| errorMsg_spamRateErrorThreshold | The campaign did not pass the SPAM check. |
| errorMsg_invalidMaillistsSelected | Some of the lists associated with the campaign do not exist. |
Body
| Key | Value | Description |
|---|---|---|
| id | 4 | Campaign ID. Required. |
| sendNow | 0 | Send now. Possible values: 1 (Send now) and 0 (Schedule). Only required when the campaign is in draft. |
| sendDate | 2022-12-31 11:00:00 | Campaign scheduling date. Format: YYYY-MM-DD HH:MM:DD. Must be later than the current date and time. Required if sendNow = 0 (Schedule). |
| resend | 1 | Schedule resend. Possible values: 0 (No) and 1 (Yes). Default is 0. |
| resendType | 2 | Resend type. Required if Schedule resend = 1. Possible values: 1 (To contacts who did not open the campaign) / 2 (To contacts who did not click on the content) / 3 (To contacts who had soft bounces) / 4 (Again to all contacts) |
| resendDays | 7 | Number of days for resending. Required if Schedule resend = 1. Maximum 999, minimum: 1. |
| resendHours | 17 | Hour for resending. Required if Schedule resend = 1. Maximum 23, minimum: 0. |
| resendMins | 40 | Minutes for resending. Required if Schedule resend = 1. Maximum 59, minimum: 0. |
Description
Allows pausing a campaign that is sending, scheduled, or under review.
Output structure:
| Field | Description |
|---|---|
| id | ID of the paused campaign. |
| status | Paused |
Errors:
| Code | Description |
|---|---|
| errorMsg_campaignNotFound | No campaign exists with the provided ID. |
| errorMsg_campaignNotActive | The campaign is in draft. |
| errorMsg_campaignPaused | The campaign is already paused. |
| errorMsg_campaignCompleted | The campaign has been sent. |
| errorMsg_campaignStopped | The campaign is stopped. |
| errorMsg_campaignNotPaused | The campaign could not be paused. |
Body
| Key | Value | Description |
|---|---|---|
| id | 112 | Campaign ID. Required. |
Description
Allows stopping a campaign that is sending, scheduled, under review, or paused.
Output structure:
| Field | Description |
|---|---|
| id | ID of the stopped campaign |
| status | Stopped |
Errors:
| Code | Description |
|---|---|
| errorMsg_campaignNotFound | No campaign exists with the provided ID. |
| errorMsg_campaignNotActive | The campaign is in draft. |
| errorMsg_campaignCompleted | The campaign has been sent. |
| errorMsg_campaignStopped | The campaign is already stopped. |
| errorMsg_campaignNotStopped | The campaign could not be stopped. |
Body
| Key | Value | Description |
|---|---|---|
| id | 112 | Campaign ID. Required. |
Description
Allows resuming a stopped or paused campaign.
Output structure:
| Field | Description |
|---|---|
| id | ID of the resumed campaign |
| status | Sending |
Errors:
| Code | Description |
|---|---|
| errorMsg_campaignNotFound | No campaign exists with the provided ID. |
| errorMsg_campaignSending | The campaign is sending or scheduled. |
| errorMsg_campaignPendingForApproval | The campaign is pending approval. |
| errorMsg_campaignCompleted | The campaign has been sent. |
| errorMsg_campaignNotPausedOrStopped | The campaign is in draft. |
| campaignBlocked | Certain issues were detected in your campaign content. |
Body
| Key | Value | Description |
|---|---|---|
| id | 127 | Campaign ID. Required. |
Description
Allows deleting one or multiple campaigns at once, considering that:
- If you want to delete a single campaign, the id must be passed as a parameter.
- If you want to delete multiple campaigns, an array of Ids must be passed as a parameter. If some of the indicated campaigns do not exist, they will be shown in the response within campaignsNotFound.
Errors:
| Code | Description |
|---|---|
| errorMsg_campaignNotFound | No campaign exists with the provided ID. |
| invalid_max_elements | A maximum of 100 records can be deleted. Only for multiple deletions. |
Body
| Key | Value | Description |
|---|---|---|
| id | 113 | Campaign ID to delete. Only one required: id (for deleting one campaign) or array of ids (for deleting multiple campaigns). |
| ids[] | 6 | Array of campaign IDs to delete. Maximum 100. Only one required: id (for deleting one campaign) or array of ids (for deleting multiple campaigns). |
Description
Allows duplicating a campaign.
Output structure:
| Field | Description |
|---|---|
| id | New campaign ID |
| name | New campaign name |
Errors:
| Code | Description |
|---|---|
| errorMsg_campaignNotFound | No campaign exists with the provided ID. |
URL Variables
| Key | Value | Description |
|---|---|---|
| campaing_id | Campaign ID. Required. |
Description
Allows forwarding a campaign.
Output structure:
| Field | Description |
|---|---|
| id | ID of the forwarded campaign |
| name | Name of the forwarded campaign |
Errors:
| Code | Description |
|---|---|
| errorMsg_campaignNotFound | No campaign exists with the provided ID. |
| errorMsg_emptyMaillistsOrSegment | The campaign cannot be forwarded because the contact list or segment no longer exists. |
| errorMsg_campaignNotCompleted | The campaign was not sent. |
Body
| Key | Value | Description |
|---|---|---|
| id | 11 | Id of the campaign to resend. Required. |
| type | 4 | Type of resend. Required. Possible values: 1 (To contacts who did not open the campaign) / 2 (To contacts who did not click on the content) / 3 (To contacts who had soft bounces) / 4 (Again to all contacts) |
| sendNow | 1 | Send now. Required. Possible values: 1 (Send now) and 0 (Schedule). |
| sendDate | 2022-12-31 11:00:00 | Resend scheduling date. Format: YYYY-MM-DD HH:MM:DD. Must be later than the current date and time. Required if sendNow = 0 (Schedule). |
Description
Allows generating a thumbnail of the campaign content.
Errors:
| Code | Description |
|---|---|
| errorMsg_campaignNotFound | No campaign exists with the provided ID. |
Body
| Key | Value | Description |
|---|---|---|
| id | 26 | Campaign ID. Required. |
| width | 300 | Image width. Required. Minimum: 200, maximum: 600. |
| height | 600 | Image height. Required. Minimum: 200, maximum: 600. |
Campaigns/automation reports 10
This module will allow you to know the report and statistics of each sent campaign/automation.
Description
Returns the general report of a campaign/automation. Keep in mind that:
- For campaigns of type = Test A/B, a statisticsDetails section is added with the detailed statistics for each Subject.
Output structure:
| Field | Description |
|---|---|
| campaign.name | Name of the campaign/automation. |
| campaign.sendDate | Date and time of sending. Only for campaigns. |
| publicURL | Public report URL |
| delivery.totalAudience | Total contacts. For Campaigns: It is the sum of all contacts included within the lists or segments to which the campaign was sent. Includes duplicates. For automation: It is the sum of all contacts who met the event. |
| delivery.repeated | Repeated contacts. Only for campaigns, automations do not have duplicates. |
| delivery.total | Total contacts - Repeated contacts |
| delivery.bounces.hard.Amount | Hard bounces |
| delivery.bounces.hard.Percentage | Percentage of hard bounces over total bounces |
| delivery.bounces.soft.Amount | Soft bounces |
| delivery.bounces.soft.Percentage | Percentage of soft bounces over total bounces |
| delivery.bounces.total | Total bounces. These are emails that could not be delivered because the destination mail servers rejected them |
| delivery.bounces.totalPercentage | Percentage of bounces over total contacts |
| delivery.pending | Total pending. These are email addresses to which the system has not yet sent the mail |
| delivery.pendingPercentage | Percentage of pending over total contacts |
| delivery.delivered | Total delivered. Includes the total emails that reached the destination |
| delivery.deliveredPercentage | Percentage of delivered over total contacts |
| performance.reads | Number of times the campaign/automation was opened |
| performance.uniqueReads | Number of contacts who opened the campaign/automation |
| performance.readsPercentage | Percentage of contacts who opened the campaign/automation over the total delivered |
| performance.clicks | Number of clicks made in the campaign/automation |
| performance.uniqueClicks | Number of contacts who clicked in the campaign/automation |
| performance.clicksPercentage | Percentage of contacts who clicked in the campaign/automation over the total delivered |
| performance.shared.total | Total shares |
| performance.shared.forwardto.Amount | Total shares by email |
| performance.shared.forwardto.Percentage | Percentage of shares by email |
| performance.shared.facebook.Amount | Total shares on Facebook |
| performance.shared.facebook.Percentage | Percentage of shares on Facebook |
| performance.shared.linkedin.Amount | Total shares on LinkedIn |
| performance.shared.linkedin.Percentage | Percentage of shares on LinkedIn |
| performance.shared.twitter.Amount | Total shares on Twitter |
| performance.shared.twitter.Percentage | Percentage of shares on Twitter |
| performance.shared.pinterest.Amount | Total shares on Pinterest |
| performance.shared.pinterest.Percentage | Percentage of shares on Pinterest |
| performance.shared.whatsapp.Amount | Total shares on Whatsapp |
| performance.shared. whatsapp.Percentage | Percentage of shares on Whatsapp |
| performance.unsubscriptions.total | Total unsubscribes |
| performance.unsubscriptions.alreadyUnsubscribed.Amount | Total unsubscribes with reason Already unsubscribed |
| performance.unsubscriptions.alreadyUnsubscribed.Percentage | Percentage of unsubscribes with reason Already unsubscribed |
| performance.unsubscriptions.irrelevant.Amount | Total unsubscribes with reason Irrelevant content |
| performance.unsubscriptions.irrelevant.Percentage | Percentage of unsubscribes due to Irrelevant content |
| performance.unsubscriptions.neverSignUp.Amount | Total unsubscribes with reason Never signed up |
| performance.unsubscriptions.neverSignUp.Percentage | Percentage of unsubscribes with reason Never signed up |
| performance.unsubscriptions.spam.Amount | Total unsubscribes with reason Considered SPAM |
| performance.unsubscriptions.spam.Percentage | Percentage of unsubscribes with reason Considered SPAM |
| performance.unsubscriptions.tooOften.Amount | Total unsubscribes with reason Too frequent |
| performance.unsubscriptions.tooOften.Percentage | Percentage of unsubscribes with reason Too frequent |
| performance.unsubscriptions.other.Amount | Total unsubscribes for other reasons |
| performance.unsubscriptions.other.Percentage | Percentage of unsubscribes for other reasons |
| performance.unsubscriptions.oneClickUnsubscribe.Amount | Total unsubscribes with One-click unsubscribe option |
| performance.unsubscriptions.oneClickUnsubscribe.Percentage | Percentage of unsubscribes with One-click unsubscribe option |
| performance.complaints | Number of complaints. It is the number of recipients who marked the campaign/automation as spam |
| statisticsDetails.A.Subject | Subject A |
| statisticsDetails.A.ContentPercentage | Send proportion (%) subject A |
| statisticsDetails.A.TotalRecipients | Total sends subject A |
| statisticsDetails.A.SentRecipients | Sends completed subject A |
| statisticsDetails.A.PendingRecipients | Pending sends subject A |
| statisticsDetails.A.ContactsReadPercentage | Opens (%) subject A |
| statisticsDetails.A.ReadAmount | Total opens subject A |
| statisticsDetails.A.UniqueReadAmount | Contacts with opens subject A |
| statisticsDetails.A.ContactsClickPercentage | Clicks (%) subject A |
| statisticsDetails.A.ClickAmount | Total clicks subject A |
| statisticsDetails.A.UniqueClickAmount | Contacts with clicks subject A |
| statisticsDetails.B.Subject | Subject B |
| statisticsDetails.B.ContentPercentage | Send proportion (%) subject B |
| statisticsDetails.B.TotalRecipients | Total sends subject B |
| statisticsDetails.B.SentRecipients | Sends completed subject B |
| statisticsDetails.B.PendingRecipients | Pending sends subject B |
| statisticsDetails.B.ContactsReadPercentage | Opens (%) subject B |
| statisticsDetails.B.ReadAmount | Total opens subject B |
| statisticsDetails.B.UniqueReadAmount | Contacts with opens subject B |
| statisticsDetails.B.ContactsClickPercentage | Clicks (%) subject B |
| statisticsDetails.B.ClickAmount | Total clicks subject B |
| statisticsDetails.B.UniqueClickAmount | Contacts with clicks subject B |
| devices.mobileTotal | Total opens on Mobile |
| devices.mobilePercentage | Percentage of opens on Mobile |
| devices.mobileAgents | Details of opens on Mobile (Count by agent and Percentage) |
| devices.desktopTotal | Total opens on Desktop |
| devices.desktopPercentage | Percentage of opens on Desktop |
| devices.desktopAgents | Details of opens on Desktop (Count by agent and Percentage) |
| devices.tabletTotal | Total opens on Tablets |
| devices.tabletPercentage | Percentage of opens on Tablets |
| devices.tabletAgents | Details of opens on Tablets (Count by agent and Percentage) |
| devices.unknownTotal | Total opens on Unknown Devices |
| devices.unknownPercentage | Percentage of opens on Unknown Devices |
Errors:
| Code | Description |
|---|---|
| errorMsg_campaignNotFound | No campaign/automation exists with the provided ID. |
URL Variables
| Key | Value | Description |
|---|---|---|
| campaign_id | 100 | Campaign/automation ID. Required. |
Description
Returns the details of the campaign/automation openings.
Output structure:
| Field | Description |
|---|---|
| Email of the contact who opened | |
| date | Date and time of the opening |
| countryCode | Country where the campaign/automation was opened (ISO Code) |
| city | City where the campaign/automation was opened (Description) |
| platform | Device where the campaign/automation was opened |
| latitude | Geographic coordinate where the campaign/automation was opened (latitude) |
| longitude | Geographic coordinate where the campaign/automation was opened (longitude) |
| app | Application where the campaign/automation was opened |
Errors:
| Code | Description |
|---|---|
| errorMsg_campaignNotFound | No campaign/automation exists with the provided ID. |
Body
| Key | Value | Description |
|---|---|---|
| id | 386 | Campaign/automation Id. Required. |
| limit | 10 | Number of records to show per page. Maximum: 100. |
| page | 1 | Page number to display. |
| order | asc | Sort by date. Possible values: asc/desc. Default: desc. |
Description
Returns the details of the clicks made in the campaign/automation.
Output structure:
| Field | Description |
|---|---|
| date | Date and time of the click |
| url | URL where the click was made |
| Email of the contact who made the click |
Errors:
| Code | Description |
|---|---|
| errorMsg_campaignNotFound | No campaign/automation exists with the provided ID. |
Body
| Key | Value | Description |
|---|---|---|
| id | 386 | Campaign/automation Id. Required. |
| limit | 10 | Number of records to show per page. Maximum: 100. |
| page | 1 | Page number to display. |
| order | asc | Sort by date. Possible values: asc/desc. Default: desc. |
Description
Returns the details of the bounces (hard and soft) recorded for the campaign/automation.
Output structure:
| Field | Description |
|---|---|
| date | Date and time of the bounce |
| type | Bounce type. Possible values: soft -> Soft bounce hard -> Hard bounce |
| Email of the contact that bounced |
Errors:
| Code | Description |
|---|---|
| errorMsg_campaignNotFound | No campaign/automation exists with the provided ID. |
Body
| Key | Value | Description |
|---|---|---|
| id | 386 | Campaign/automation Id. Required. |
| limit | 10 | Number of records to display per page. Maximum: 100. |
| page | 1 | Page number to display. |
| order | asc | Sort by date. Possible values: asc/desc. Default: desc. |
| type | hard | Filter by bounce type. Possible values: soft/hard. |
Description
Returns the details of unsubscribes made in the campaign/automation.
Output structure:
| Field | Description |
|---|---|
| date | Date and time of the unsubscribe |
| reason | Reason for unsubscribing. Possible values: irrelevant -> Irrelevant content tooOften -> Too frequent neverSignUp -> I never subscribed alreadyUnsubscribed -> I already unsubscribed spam -> I consider it SPAM other -> Others OneClickUnsubscribe -> One-click unsubscribe |
| note | Additional notes when reason = Others is selected |
| Email of the contact who unsubscribed |
Errors:
| Code | Description |
|---|---|
| errorMsg_campaignNotFound | No campaign/automation exists with the provided ID. |
Body
| Key | Value | Description |
|---|---|---|
| id | 386 | Campaign/automation Id. Required. |
| limit | 10 | Number of records to display per page. Maximum: 100. |
| page | 1 | Page number to display. |
| order | asc | Sort by date. Possible values: asc/desc. Default: desc. |
Description
Returns the details of complaints made in the campaign/automation.
Output structure:
| Field | Description |
|---|---|
| date | Date and time of the complaint |
| Email of the contact who made the complaint |
Errors:
| Code | Description |
|---|---|
| errorMsg_campaignNotFound | No campaign/automation exists with the provided ID. |
Body
| Key | Value | Description |
|---|---|---|
| id | 386 | Campaign/automation Id. Required. |
| limit | 10 | Number of records to display per page. Maximum: 100. |
| page | 1 | Page number to display. |
| order | asc | Sort by date. Possible values: asc/desc. Default: desc. |
Description
Returns the details of excluded contacts either due to duplication or being on the exclusion list. Note that the latter were only recorded in previous versions; they are no longer recorded.
Output structure:
| Field | Description |
|---|---|
| Email of the excluded contact | |
| reason | Reason for exclusion. Possible values: duplicated -> Duplicated banned -> On exclusion list |
Errors:
| Code | Description |
|---|---|
| errorMsg_campaignNotFound | Campaign/automation with the provided ID does not exist. |
Body
| Key | Value | Description |
|---|---|---|
| id | 386 | Campaign/automation ID. Required. |
| limit | 10 | Number of records to display per page. Maximum: 100. |
| page | 1 | Page number to display. |
| order | asc | Sort by email. Possible values: asc/desc. Default: desc. |
Description
Returns a file with the details of the contacts to whom the campaign/automation was sent.
Important: This information will only be available for 6 months from the sending of the campaign/automation, after that time it can no longer be downloaded.
Output structure:
A file sents.txt will be generated containing on each line: sending date, sending time, and email of the contact to whom the campaign/automation was sent.
Errors:
| Code | Description |
|---|---|
| errorMsg_campaignNotFound | Campaign/automation with the reported ID does not exist |
| errorMsg_campaignStatisticsNotFound | The campaign/automation has not been sent yet |
| errorMsg_campaignSentsNotFound | The file is no longer available because more than 6 months have passed since the campaign/automation was sent |
Body
| Key | Value | Description |
|---|---|---|
| id | 352 | Campaign/automation Id. Required. |
Description
Returns a file with the details of duplicate contacts.
Important: This information will only be available for 6 months from the sending of the campaign/automation, after that time it will no longer be downloadable.
Output structure:
A file duplicates.csv will be generated containing two data points: email of the repeated contact and number of repetitions.
Errors:
| Code | Description |
|---|---|
| errorMsg_campaignNotFound | No campaign/automation exists with the reported ID |
| errorMsg_campaignStatisticsNotFound | The campaign/automation has not yet been sent |
| errorMsg_campaignDuplicatesNotFound | The file is no longer available because more than 6 months have passed since the sending of the campaign/automation |
Body
| Key | Value | Description |
|---|---|---|
| id | 9 | Campaign/automation Id. Required. |
Contact lists 6
This module groups services for managing contact lists that can be used in your campaigns.
Description
Returns a list of all contact lists. They can be filtered by name.
Output structure:
| Field | Description |
|---|---|
| id | List ID |
| name | List name |
| count | Number of contacts |
| lastSend | Date of last send |
Body
| Key | Value | Description |
|---|---|---|
| name | name | Filter by name or part of the list name. |
| limit | 10 | Number of records to display per page. Maximum: 100. |
| page | 1 | Page number to display. |
| orderBy | id | Criterion to order the lists. Possible values: name/id. Default: id. |
| order | desc | Type of ordering. Possible values: asc/desc. Default: desc. |
Description
Allows creating a new list.
Output structure:
| Field | Description |
|---|---|
| id | ID of the created list |
| name | Name of the list |
Body
| Key | Value | Description |
|---|---|---|
| name | New list | List name. Required. Special characters are not allowed. |
Description
Allows editing a list.
Errors:
| Code | Description |
|---|---|
| errorMsg_contactListNotFound | No list exists with the provided ID. |
Body
| Key | Value | Description |
|---|---|---|
| id | 1 | List ID. Required. |
| name | Test list | List name. Required. Special characters are not allowed. |
Description
Allows deleting a list.
Errors:
| Code | Description |
|---|---|
| errorMsg_listContactNotFound | No list exists with the provided ID. |
URL Variables
| Key | Value | Description |
|---|---|---|
| list_id | 10 | Id of list to delete. Required. |
Description
Allows deleting multiple contact lists at once, considering that:
- If some of the indicated lists do not exist, they will be shown in the response within mailListsNotFound.
Errors:
| Code | Description |
|---|---|
| invalid_max_elements | A maximum of 100 records can be deleted. |
Body
| Key | Value | Description |
|---|---|---|
| ids[] | 6 | Array of list IDs to delete. Required. Maximum 100. |
Contact reports 6
This module will allow you to know the details of the contact’s activity.
Description
Returns the details of campaign opens performed by the contact.
Output structure:
| Field | Description |
|---|---|
| date | Date and time of the open |
| countryCode | Country from which it was opened |
| platform | Device from which it was opened |
| campaignName | Campaign name |
Errors:
| Code | Description |
|---|---|
| errorMsg_contactNotFound | No contact exists with the provided ID. |
Body
| Key | Value | Description |
|---|---|---|
| id | 2 | Contact ID. Required. |
| limit | 10 | Number of records to display per page. Maximum: 100. |
| page | 1 | Page number to display. |
| order | asc | Sort by date. Possible values: asc/desc. Default: desc. |
Description
Returns the details of the clicks made by the contact.
Output structure:
| Field | Description |
|---|---|
| date | Date and time of the click |
| url | URL where the click was made |
| campaignName | Name of the campaign |
Errors:
| Code | Description |
|---|---|
| errorMsg_contactNotFound | No contact exists with the provided ID. |
Body
| Key | Value | Description |
|---|---|---|
| id | 2 | Contact ID. Required. |
| limit | 10 | Number of records to display per page. Maximum: 100. |
| page | 1 | Page number to display. |
| order | asc | Sort by date. Possible values: asc/desc. Default: desc. |
Description
Returns the details of the bounces (hard and soft) that were recorded for the contact.
Output structure:
| Field | Description |
|---|---|
| date | Date and time of the bounce |
| type | Type of bounce. Possible values: soft -> Soft bounce hard -> Hard bounce |
| campaignName | Campaign name |
Errors:
| Code | Description |
|---|---|
| errorMsg_contactNotFound | No contact exists with the provided ID. |
Body
| Key | Value | Description |
|---|---|---|
| id | 2 | Contact ID. Required. |
| limit | 10 | Number of records to display per page. Maximum: 100. |
| page | 1 | Page number to display. |
| order | asc | Sort by date. Possible values: asc/desc. Default: desc. |
| type | hard | Filter by bounce type. Possible values: soft/hard. |
Description
Returns the details of the unsubscribes made by the contact from the campaigns.
Output structure:
| Field | Description |
|---|---|
| date | Date and time of the unsubscribe |
| reason | Reason for the unsubscribe. Possible values: irrelevant -> Irrelevant content tooOften -> Too frequent neverSignUp -> I never subscribed alreadyUnsubscribed -> I already unsubscribed spam -> I consider it SPAM other -> Others |
| campaignName | Campaign name |
Errors:
| Code | Description |
|---|---|
| errorMsg_contactNotFound | No contact exists with the provided ID. |
Body
| Key | Value | Description |
|---|---|---|
| id | 2 | Contact ID. Required. |
| limit | 10 | Number of records to display per page. Maximum: 100. |
| page | 1 | Page number to display. |
| order | asc | Sort by date. Possible values: asc/desc. Default: desc. |
Description
Returns the details of complaints made by the contact from the campaigns.
Output structure:
| Field | Description |
|---|---|
| date | Date and time of the complaint |
| campaignName | Name of the campaign |
Errors:
| Code | Description |
|---|---|
| errorMsg_contactNotFound | No contact exists with the provided ID. |
Body
| Key | Value | Description |
|---|---|---|
| id | 2 | Contact ID. Required. |
| limit | 10 | Number of records to display per page. Maximum: 100. |
| page | 1 | Page number to display. |
| order | asc | Sort by date. Possible values: asc/desc. Default: desc. |
Contacts 8
This module will allow you to perform all management associated with contacts that will later be used in lists and/or segments.
Description
Returns a list with all contacts. They can be filtered by email or by list.
Output structure:
| Field | Description |
|---|---|
| id | Contact ID |
| Contact email | |
| created | Creation date |
| lastSend | Date of last send |
| subscriptions | Number of lists subscribed to |
Errors:
| Code | Description |
|---|---|
| errorMsg_mailListNotFound | No list found with the provided ID. |
Body
| Key | Value | Description |
|---|---|---|
| luis | Filter by email or part of the contact’s email. | |
| listId | 2 | Filter by contact list. |
| limit | 10 | Number of records to show per page. Maximum: 100. |
| page | 1 | Page number to display. |
| orderBy | id | Criterion to order the contacts. Possible values: email/id. Default: id |
| order | asc | Sorting type. Possible values: asc/desc. Default: desc. |
Description
Returns the details of a contact.
Output structure:
| Field | Description |
|---|---|
| id | Contact ID |
| Contact email | |
| created | Creation date |
| lastActivity | Last activity date |
| mailLists | List(s) subscribed to (ID and Name) |
| customFields | Custom fields (ID, Name, Type, and Value) |
| lastSend | Date of last send |
| reads | Total opens |
| clicks | Total clicks |
| hardBounce | Hard bounces |
| softBounce | Soft bounces |
| shared | Shares |
| unsubscription | Unsubscriptions |
| complaint | Complaints |
Errors:
| Code | Description |
|---|---|
| errorMsg_contactNotFound | No contact exists with the provided ID. |
URL Variables
| Key | Value | Description |
|---|---|---|
| contact_id | 2 | Contact ID. Required. |
Body
Description
Allows creating a new contact, taking into account the following considerations:
- Only the email address is required.
- The contact will be assigned to the lists through another service.
- To complete the custom fields, the following criteria will be used:
- If the field is sent with a value, it will be completed with that value.
- If the field is sent empty, the field will be completed with an empty value.
- If the field is not sent, it will be completed with the default configured value (if any).
Output structure:
| Field | Description |
|---|---|
| id | ID of the created contact |
| Email of the contact |
Errors:
| Code | Description |
|---|---|
| errorMsg_contactAlreadyExist | A contact with the same email already exists. |
| customsFieldsNotFound | The indicated custom field does not exist. |
Body
| Key | Value | Description |
|---|---|---|
| sofia@example.com | New contact’s email. Required. | |
| customFields[1] | Sofia | Array of custom fields. The ID of the field to be filled must be placed as the key of the array. If it is a date type value, it must be in MM-DD format. In the case of a multiple options list, separate the options with commas and no spaces. For example: option1,option3. |
Description
Allows editing a contact, taking into account the following considerations:
- No field is required.
- The contact will be assigned to lists through another service.
- To edit custom fields, the following criteria will be used:
- If the field is sent with a value, it is modified with the indicated value.
- If the field is sent empty, it is modified with the indicated value (blank).
- If the field is not sent, the field value is not updated and the current value remains.
Errors:
| Code | Description |
|---|---|
| errorMsg_contactNotFound | No contact exists with the provided ID. |
| customsFieldsNotFound | The indicated custom field does not exist. |
Body
| Key | Value | Description |
|---|---|---|
| id | 6 | Contact id. Required. |
| customFields[1] | Sofía | Array of custom fields. The id of the field to be completed must be placed as the key of the array. In the case of a date type value, it must be in MM-DD format. In the case of a multiple options list, separate the options with commas and no spaces. For example: option1,option3. |
Description
Allows subscribing multiple contacts to a list, taking into account the following considerations:
- Contacts that are excluded cannot be subscribed. In these cases, they will be shown in the response within contactExclude and will not be subscribed.
- If some of the indicated contacts do not exist, they will be shown in the response within contactNotFound.
Errors:
| Code | Description |
|---|---|
| errorMsg_mailListNotFound | No contact list exists with the provided ID. |
| invalidContacts | None of the contacts were subscribed either because they do not exist or because they are excluded |
Body
| Key | Value | Description |
|---|---|---|
| contactsIds[] | 4 | Array of contact Ids to subscribe. Required. Maximum: 100 records. |
| listId | 1 | List Id. Required. |
Description
Allows unsubscribing multiple contacts from a list, taking into account the following considerations:
- If some of the specified contacts do not exist, they will be shown in the response within contactNotFound.
- Contacts that are not subscribed to the indicated list will be shown in the response within subscribeNotFound.
Errors:
| Code | Description |
|---|---|
| errorMsg_mailListNotFound | No contact list exists with the provided ID. |
| invalidContacts | None of the contacts were unsubscribed either because they do not exist or because they were not subscribed to the indicated list. |
Body
| Key | Value | Description |
|---|---|---|
| contactsIds[] | 12 | Array of contact Ids to unsubscribe. Required. Maximum: 100 records. |
| listId | 1 | List Id. Required. |
Description
Allows deleting multiple contacts, considering that:
- If some of the indicated contacts do not exist, they will be shown in the response within contactsNotFound.
Errors:
| Code | Description |
|---|---|
| errorMsg_contactsNotFound | None of the reported contacts exist. |
Body
| Key | Value | Description |
|---|---|---|
| contactsIds[] | 49 | Array of contact Ids to delete. Required. |
Description
Allows uploading contacts from a CSV file. Maximum file size: 30MB.
Errors:
| Code | Description |
|---|---|
| errorMsg_invalidCountColumnsInParams | The number of columns in the file does not match the number indicated in the parameters. |
| errorMsg_columnEmailNotFound | The Email column must be parameterized. |
| errorMsg_mailListNotFound | No list exists with the indicated ID. |
| invalid_max_size_file | The file size exceeded the maximum allowed: 30MB. |
Body
| Key | Value | Description |
|---|---|---|
| csv | CSV file. Required. | |
| mailList | 6 | List ID. Required. |
| qualifier | doubleQuote | Field delimiter. Required. Possible values: quote (Single quote) and doubleQuote (Double quote) |
| delimiter | comma | Column separator. Required. Possible values: comma (Comma) / semicolon (Semicolon) / numberSign (Number sign) / dollarSign (Dollar sign) |
| ignoreFirstRow | 1 | Ignore the first row of the file. Required. Possible values: 0 (No) and 1 (Yes). |
| columns[0] | Array indicating which field corresponds to each column of the CSV file. Possible values: Email (Corresponds to the Email column) CustomFieldX (Corresponds to the code of the custom field indicated for the column. See possible values in: Get collection of custom fields). Column values start at position 0. That is, columns[0] represents the first column of the CSV file. | |
| columns[1] | CustomField1 | |
| columns[2] | CustomField4 |
Custom fields 7
This module groups services for managing custom fields used for contact information, subscription forms, and the customization of your campaigns.
Description
Returns a list with all custom fields. They can be filtered by name.
Output structure:
| Field | Description |
|---|---|
| id | Custom field ID |
| name | Custom field name |
| code | Custom field code. With this code you can include the custom fields in the subject and content of the campaign |
| type | Field type. See possible values at: Get custom field types |
| validation | Validation type. See possible values at: Get custom field validations. Shown only for Field type = Text field or Hidden field |
| validationCustomRegExp | Custom validation. Shown only if Validation = Custom) |
| options_values | Possible options. Shown only for Field type = List or List with multiple selection or List with single selection |
| value_default | Default value. Shown only for Field type = Text field or Hidden field or Annual event |
| date_value | Default date. Shown only for Field type = Annual event |
Body
| Key | Value | Description |
|---|---|---|
| name | field | Filter by name or part of the custom field name. |
| type | Text field | Filter by field type. See possible values at: Get custom field types. |
| limit | 10 | Number of records to show per page. Maximum: 100. |
| page | 1 | Page number to display. |
| orderBy | name | Criteria to order the fields. Possible values: name/id. Default: id. |
| order | asc | Order type. Possible values: asc/desc. Default: desc. |
Description
Returns the details of a custom field.
Output structure:
| Field | Description |
|---|---|
| id | ID of the custom field. |
| name | Name of the custom field |
| code | Code of the custom field. With this code, you can include the custom fields in the subject and content of the campaign |
| type | Field type. See possible values in: Get custom field types |
| validation | Validation type. See possible values in: Get custom field validations Shown only for Field type = Text field or Hidden field. |
| validationCustomRegExp | Custom validation. Shown only if Validation = Custom) |
| options_values | Possible options. Shown only for Field type = List or List with multiple selection or List with single selection |
| value_default | Default value. Shown only for Field type = Text field or Hidden field or Annual event |
| date_value | Default date. Shown only for Field type = Annual event |
Errors:
| Code | Description |
|---|---|
| errorMsg_customFieldNotFound | Custom field with the provided ID does not exist. |
URL Variables
| Key | Value | Description |
|---|---|---|
| customfield_id | 3 | Id of the custom field. |
Description
Returns a list of validation types that will be used in the creation and/or editing of custom fields type = Text field or Hidden field.
Detail of the values:
Below is a description of the current values:
| Value | Description |
|---|---|
| Do not Apply | Disable |
| Numeric Only | Accept digits only |
| Alpha Only | Accept letters and spaces only |
| Alpha Numeric Only | Accept letters, numbers, and spaces only |
| Email Format Check | Accept email addresses only |
| Custom | Custom |
Description
Returns a list of field types that will be used in the creation and/or editing of custom fields.
Details of the values:
Below is a description of the current values:
| Value | Description |
|---|---|
| Text field | Text field |
| Hidden field | Hidden field |
| Check box | List with multiple selection |
| Radio button | List with single selection |
| Annual Date | Annual event |
| Drop list | List |
Description
Allows creating a new custom field, taking into account the following considerations:
- Name and Field Type will always be required.
- For fields of type = Text field or Hidden field, the following parameters will always be requested:
- Validation type. It is required to provide a value.
- Regular expression. It is required to provide a value for Validation = Custom.
- Default value. It is not required to provide a value, so it can be left blank.
- For Field Type = List or List with multiple selection or List with single selection, the Options parameter will always be requested, and it is required to provide a value.
- For Field Type = Annual event, the Default value parameter will always be requested but it is not required to provide a value, so it can be left blank.
Errors:
| Code | Description |
|---|---|
| valueDefaultWithValidationCustomRegExp | The default value does not comply with the custom validation. |
Body
| Key | Value | Description |
|---|---|---|
| name | Last name | Field name. Required. |
| type | Text field | Field type. See possible values at: Get custom field types. Required. |
| validation_type | Do not Apply | Validation type. See possible values at: Get custom field validations. Required if Field type = Text field or Hidden field. |
| validationCustomRegExp | /^[0-9]*$/ | Regular expression for field validation. Required for Validation = Custom. |
| value_default | Unknown | Default value. Required for Field type = Text field or Hidden field. The value can be left blank. |
| options_values[] | Option1 | Array with option values. It is required to indicate at least one option with a value for Field Type = List or List with multiple selection or List with single selection. |
| date_value | 02-28 | Default annual date. Format: MM-DD. Required for Field Type = Annual event. The value can be left blank. |
Description
Allows editing a custom field, taking into account the following considerations:
- Name and Field Type will always be required.
- For fields of type = Text field or Hidden field, the following parameters will always be requested:
- Validation type. It is required to indicate a value.
- Regular expression. It is required to indicate a value for Validation = Custom.
- Default value. It is not required to indicate a value, so it can be left blank.
- For Field Type = List or List with multiple selection or List with single selection, the Options parameter will always be requested, and it is required to indicate a value.
- For Field Type = Annual event, the Default value parameter will always be requested but it is not required to indicate a value, so it can be left blank.
Errors:
| Code | Description |
|---|---|
| errorMsg_customFieldNotFound | Custom field with the informed ID does not exist. |
| valueDefaultWithValidationCustomRegExp | The default value does not comply with the custom validation. |
Body
| Key | Value | Description |
|---|---|---|
| id | 8 | Custom field ID to modify. Required. |
| name | Date of birth | Field name. Required. |
| type | Annual Date | Field type. See possible values at: Get custom field types. Required. |
| validation_type | Custom | Validation type. See possible values at: Get custom field validations. Required if Field type = Text field or Hidden field. |
| validationCustomRegExp | /^[0-9]*$/ | Regular expression for field validation. Required for Validation = Custom. |
| value_default | Unknown | Default value. Required for Field type = Text field or Hidden field. The value can be left blank. |
| options_values[] | Option1 | Array with option values. It is required to indicate at least one option with value for Field type = List or List with multiple selection or List with single selection. |
| date_value | 02-29 | Default annual date. Format: MM-DD. Required for Field type = Annual event. The value can be left blank. |
Description
Allows deleting a custom field as long as it is not being used in any segment, form, or automation.
Errors:
| Code | Description |
|---|---|
| errorMsg_customFieldNotFound | No custom field exists with the provided ID. |
| errorMsg_customFieldIsUsed | The custom field cannot be deleted because it is being used in some segment, form, or automation. |
URL Variables
| Key | Value | Description |
|---|---|---|
| customfield_id | 5 | ID of the custom field to delete. Required. |
Exclusions 3
This module will allow you to manage all contact exclusions so that your campaigns are not sent to them.
Description
Returns a list of all exclusions created by User. They can be filtered by email.
Body
| Key | Value | Description |
|---|---|---|
| email@example.com | Filter by email. | |
| limit | 5 | Number of records to display per page. Maximum: 100. |
| page | 1 | Page number to display. |
| orderBy | Criterion to sort exclusions. Possible values: email/id. Default: id. | |
| order | asc | Type of sorting. Possible values: asc/desc. Default: desc. |
Description
Allows creating exclusions, considering that:
- In case some of the indicated lists do not exist, they will be shown in the response within listsNotFound.
Errors:
| Code | Description |
|---|---|
| msg_listsNotFounds | None of the informed lists exist. |
Body
| Key | Value | Description |
|---|---|---|
| always | 0 | Type of exclusion. Possible values: 0 (on selected lists) / 1 (on all current and future lists). |
| emails[] | exclusion@example.com | Array of contact Ids to exclude. Required. Maximum: 100 records. |
| listIds[] | 1 | Array of list Ids. Required for Exclusion Type = On segmented lists. Maximum: 100 records. |
Description
Allows deleting an exclusion created by User.
Errors:
| Code | Description |
|---|---|
| errorMsg_exclusionNotFound | No exclusion exists with the provided ID. |
URL Variables
| Key | Value | Description |
|---|---|---|
| exclusion_id | 3 | Id of exclusion to delete. Required. |
Body
Files 6
Description
Returns a list of your images. They can be filtered by name or by a folder.
Output structure:
| Field | Description |
|---|---|
| id | Image ID. |
| name | Image name. |
| extension | Image extension. |
| folder | Folder ID where it is located. |
| file | Image URL. |
| created_date | Upload date. |
| thumbnail | Thumbnail URL. |
Body
| Key | Value | Description |
|---|---|---|
| name | creative | Filter by image name. |
| folder | 6926fd0ed8209d19b623115b | Filter by folder ID. Folder IDs are obtained at: Get folder collection. |
| limit | 10 | Number of records to display per page. Maximum: 100. |
| page | 1 | Page number to display. |
| orderBy | name | Criterion to sort the images. Possible values: name | extension | created_date. Default: created_date. |
| order | asc | Type of sorting. Possible values: asc/desc. Default: desc. |
Description
Returns a list of your image folders. They can be filtered by name.
Output structure:
| Field | Description |
|---|---|
| id | Folder ID |
| name | Folder name |
Body
| Key | Value | Description |
|---|---|---|
| name | Brochures | Filter by folder name. |
| order | asc | Sort type. Possible values: asc/desc. Default: asc. Always sorts by folder name. |
| limit | 10 | Number of records to display per page. Maximum: 100. |
| page | 1 | Page number to display. |
Description
Returns a list of your documents. They can be filtered by name or by a folder.
Output structure:
| Field | Description |
|---|---|
| id | Document ID |
| name | Document name |
| extension | Document extension |
| folder | Folder ID where it is located. |
| file | Document URL. |
| created_date | Upload date. |
Body
| Key | Value | Description |
|---|---|---|
| name | catalog | Filter by document name. |
| folder | 6926fd0ed8209d19b628515b | Filter by folder ID. Folder IDs are obtained in: Get folder collection. |
| limit | 10 | Number of records to display per page. Maximum: 100. |
| page | 1 | Page number to display. |
| orderBy | name | Criteria to sort documents. Possible values: name | extension | created_date. Default: created_date. |
| order | asc | Sorting type. Possible values: asc/desc. Default: desc. |
Description
Returns a list of your document folders. They can be filtered by name.
Output structure:
| Field | Description |
|---|---|
| id | Folder ID |
| name | Folder name |
Body
| Key | Value | Description |
|---|---|---|
| name | Logos | Filter by folder name. |
| order | asc | Sort type. Possible values: asc/desc. Default: asc. Always sorts by folder name. |
| limit | 10 | Number of records to display per page. Maximum: 100. |
| page | 1 | Page number to display. |
Description
Returns a list of your saved blocks. They can be filtered by name.
Output structure:
| Field | Description |
|---|---|
| id | Block ID. |
| name | Block name. |
| thumbnail | Thumbnail URL. |
| created_date | Upload date. |
Body
| Key | Value | Description |
|---|---|---|
| name | desusc | Filter by block name. |
| limit | 10 | Number of records to display per page. Maximum: 100. |
| page | 1 | Page number to display. |
| orderBy | name | Criterion to sort the blocks. Possible values: name | created_date. Default: created_date. |
| order | asc | Sorting type. Possible values: asc/desc. Default: desc. |
Description
Returns the details of a block.
Output structure:
| Field | Description |
|---|---|
| id | Block ID |
| name | Block name |
| created_date | Creation date |
| thumbnail | Thumbnail URL |
| html | Content HTML |
Errors:
| Code | Description |
|---|---|
| errorMsg_blockNotFound | No block exists with the provided ID. |
URL Variables
| Key | Value | Description |
|---|---|---|
| block_id | 69459a53e1b805319487ba83 | Block ID. Required. |
Forms 2
This module will allow you to manage all form-related tasks so that contacts can subscribe to your lists.
Description
Returns a list of all forms. They can be filtered by name.
Output structure:
| Field | Description |
|---|---|
| id | Form ID |
| name | Form name |
Body
| Key | Value | Description |
|---|---|---|
| name | test | Filter by name or part of the form’s name. |
| limit | 10 | Number of records to show per page. Maximum: 100. |
| page | 1 | Page number to display. |
| orderBy | name | Criterion to order the forms. Possible values: name/id. Default: id. |
| order | asc | Sorting type. Possible values: asc/desc. Default: desc. |
Description
Returns the details of a form.
Output structure:
| Field | Description |
|---|---|
| id | Form ID |
| name | Form name |
| mailLists | Contact list(s) (ID and Name) |
| urlSubsOK | Successful subscription URL |
| urlSubsError | Failed subscription URL |
| notificationEmail | Email to receive notification upon contact subscription |
| emailConfirm.subject | Confirmation email subject |
| emailConfirm.fromName | Confirmation email sender name |
| emailConfirm.fromEmail | Confirmation email “from” address |
| emailConfirm.replyToEmail | Confirmation email “reply-to” address |
| urlConfirmOK | Successful subscription confirmation URL |
| urlConfirmError | Failed subscription confirmation URL |
| scriptFormWebSite | Code for your website |
| urlFormWebSite | Link for social networks |
| codeQR | QR code |
Errors:
| Code | Description |
|---|---|
| errorMsg_formNotFound | No form exists with the provided ID. |
URL Variables
| Key | Value | Description |
|---|---|---|
| form_id | 1 | Form ID. Required. |
Segments 1
This module allows you to get details of the segments that can be used in your campaigns.
Description
Returns a list of all segments. They can be filtered by name.
Output structure:
| Field | Description |
|---|---|
| id | Segment ID |
| name | Segment name |
| created | Creation date |
| members | Number of contacts |
| lastSend | Date of last send |
Body
| Key | Value | Description |
|---|---|---|
| name | name | Filter by name or part of the segment name. |
| limit | 10 | Number of records to display per page. Maximum: 100. |
| page | 1 | Page number to display. |
| orderBy | id | Criterion to order the segments. Possible values: name/id. Default: id. |
| order | asc | Type of ordering. Possible values: asc/desc. Default: desc. |
Tasks 1
This module will allow you to get the details of the tasks generated from the tool.
Description
Returns a list of completed tasks. They can be filtered by status.
Output structure:
| Field | Description |
|---|---|
| id | Task ID |
| date | Date and time of the task |
| type | Task performed. Possible values: excludeContacts -> Load exclusions contactsCopied -> Contact management>Copy contactsMoved -> Contact management>Move contactsExported -> Contact management>Export contactsUnsubscribed -> Contact management>Unsubscribe contactsDeleted -> Contact management>Delete importContacts -> Contact import segmentUpdated -> Segment update reportSummary -> Campaign reports>Summary report reportReads -> Campaign reports>Opens reportClicks -> Campaign reports>Clicks reportPerformance -> Campaign reports>Performance reportDelivery -> Campaign reports>Delivered reportShareds -> Campaign reports>Shared reportUnsubscriptions -> Campaign reports>Unsubscriptions reportExclusions -> Campaign reports>Exclusions reportBounces -> Campaign reports>Bounces reportComplaints -> Campaign reports>Complaints reportSent -> Campaign reports>Sent reportBans -> Export exclusions reportSummaryMulti -> Select multiple reports>Export reports downloadGDPR -> Export account data exportSegment -> Segments>Export exportList -> Lists>Export |
| details.total | Total processed. This field is only shown for tasks that perform processing on records. |
| details.imported | Total contacts imported. This field is only shown for the importContacts task. |
| details.notImported | Total contacts NOT imported. This field is only shown for the importContacts task. |
| details.sourceImport | Type of import. This field is only shown for the importContacts task. Possible values: copypaste -> From Copy and Paste .csv -> From CSV file Gmail -> From Gmail Outlook -> From Outlook |
| details.moved | Total contacts moved. This field is only shown for the contactsMoved task. |
| details.notMoved | Total contacts NOT moved. This field is only shown for the contactsMoved task. |
| details.copied | Total contacts copied. This field is only shown for the contactsCopied task. |
| details.notCopied | Total contacts NOT copied. This field is only shown for the contactsCopied task. |
| details.campaingName | Name of the reference campaign. This field is only shown for tasks related to Campaign reports. |
| details.name | Name of the segment or list. This field is only shown for tasks performed on segments or lists. |
| details.contacts | Number of contacts. This field is only shown for the segmentUpdated task. |
| downloadLink | Link to download the file. To download it, authentication will be required in the same way as in the rest of the services. Note: The downloadGDPR and segmentUpdated tasks are the only tasks that DO NOT generate files. |
| status | Task status. Possible values: completed -> Completed pending -> In process |
Body
| Key | Value | Description |
|---|---|---|
| status | completed | Filter by task status. Possible values: completed (Finished) and pending (In process). |
Templates 1
This module will allow you to get the details of your templates, to then use them to create the content of your campaigns/automations.
Description
Returns a list of all templates. They can be filtered by tags.
Output structure:
| Field | Description |
|---|---|
| id | Template ID |
| name | Template name |
| tags | Tags |
| created | Template creation date |
| thumbUrl | Thumbnail URL |
Body
| Key | Value | Description |
|---|---|---|
| tags[] | Christmas | Array of tags |
| tags[] | Happy | Array of tags |
| limit | 10 | Number of records to display per page. Maximum: 100. |
| page | 1 | Page number to display. |
| orderBy | id | Criterion to order the templates. Possible values: creation/id. Default: creation. |
| order | asc | Type of ordering. Possible values: asc/desc. Default: desc. |
| name | Christmas | Filter by template name. |