2/12/2018
Replaced simple numbers with the ContactHistEventType values
Read more- [ADDED] class
ContactHistEventType - [CHANGED] class
ContactHistory
Welcome to the Doali API Documentation.
If you are a developer building an application we recommend using this HTTP API, which is more flexible and efficient than standard SMTP.
This API is a powerful service which allows direct access to all functionality for the Doali Dashboard and additional calls that may be required for tight integration with our Email services.
Most of API requests should be sent using an HTTP GET method. If a method needs sending using an HTTP POST method, it is designated in the method description.
To start using this API, you will need your API Key (available here). Remember to keep it safe.
| Use | Full Path for API connection | ||
|---|---|---|---|
| Base URL | Path | Parameters | |
| Doali | https://api.doali.com | /v2/category/action | ?param1=value1¶m2=value2 |
| Private Branding* | https://api.yourdomain.com | ||
| Example | https://api.doali.com | /v2/contact/list | ?apikey=your-apikey |
* You can create a CNAME in your DNS software and turn on private branding on your Account screen to brand api calls for your customers
Common API Calls:
Interface Libraries for this API have been written for several languages. Access them along with code samples here: /support/http-api/integration-libraries/
We at Doali improve our system daily by releasing new features, eliminating bugs, and bringing you fresh documentation. Have a look and catch up with the latest changes.
2/12/2018
Replaced simple numbers with the ContactHistEventType values
Read moreContactHistEventTypeContactHistory2/9/2018
Replaced 'Attachment' class with 'File' class and revamped some of the methods to better indicate its role in the system. User is now able to use preloaded Files as an attachment when sending an e-mail via 'attachments' parameter.
Read moreAttachment
Fileattachmentsto method Email/Send2/1/2018
Properly returning corresponding HTTP Status Codes when downloading a File
Read moreContact/ExportUnsubscribeReasonCount1/25/2018
Properly returning corresponding HTTP Status Codes when downloading a File
1/16/2018
Added Sent/Opened/Clicked dates to the EmailStatus class
Read moreEmailStatus12/15/2017
Replaced 'channelID' with 'channelName' for Export requests. The old parameter is still available for backward compatibility.
Read morechannelID from method Log/Export
channelNameto method Log/ExportchannelID from method Log/ExportLinkTracking
channelNameto method Log/ExportLinkTracking11/24/2017
Added additional data ('data' field) to the Contact History
Read moreContactHistory11/14/2017
Added info about domain ownership
Read moreDomainDetail10/18/2017
Added info about Sent/Opened/Clicked dates to the emails log
Read moreRecipient10/17/2017
Added info about domain tracking certificate
Read moreDomainDetailTrackingType10/13/2017
Added custom fields data to loading contact API
Read moreContact10/12/2017
Fixed publicListIDs parameters in contact/add API call to enable providing IDs separated by commas
Read morepublicListIDin method Contact/Add10/2/2017
Added the 'rule' parameter to the MoveContacts API call
Read moreruleto method List/MoveContacts9/14/2017
Added a new request to preview the unsubscribe reason breakdowns
Read moreContact/CountByUnsubscribeReason8/16/2017
Added a warning when trying to delete a list that is actively used by a Campaign
Read moreList/Delete8/11/2017
Bug fix for LoadTemplate call failing incorrectly when the template has not been found. Fixed many parameters' description order
Read moreTemplate/LoadTemplate8/2/2017
Bug fix for the MoveContacts call moving all contacts with the given status instead of moving the old list's ones
Read moreList/MoveContacts7/31/2017
Forcing the new campaigns to have at least one active Campaign Template to prevent further issues
Read moreCampaign/AddCampaign/Update7/18/2017
Bug fix for templates with name and subject longer than 200 characters returning an unknown error
Read moreTemplate/AddTemplate/UpdateTemplate/Copy7/14/2017
Bug fix for campaigns with name longer than 191 characters returning an unknown error
Read moreCampaign/AddCampaign/Update7/6/2017
Replaced the string parameter 'interval' with an enum type in log/summary
Read moreIntervalTypeintervalin method Log/Summary7/5/2017
Moved the DeliveryReason field to the UpdateAdvancedOptions call
Read moreUnsubscribeReasonto method Account/UpdateAdvancedOptionsUnsubscribeReason from method Account/UpdateProfile
AdvancedOptions7/4/2017
Bugfixes
6/27/2017
Modified some parameters' descriptions to make them more specific
6/21/2017
Fixed the Usage class not being visible in the API
Read moreUsage6/19/2017
Better error handling in some cases for the dynamic contacts
6/14/2017
Filled the return types' information for some API calls. API documentation now correctly displays what kind of result can you expect from the given call.
Campaign/Copy now returns new campaign's ID instead of nothing.
Campaign/Copy6/6/2017
Modified the ChangeEmail request to return information about the sent e-mail with the verification link. The sourceUrl parameter is now optional.
Read moreAccount/ChangeEmailsourceUrlin method Account/ChangeEmail5/29/2017
NEW: option to set your custom e-mail headers that will be appended to every e-mail.
Read moreCustomHeaderAccount/UpdateCustomHeadersAccount/LoadCustomHeaders5/22/2017
Added the 'last-bounce' error info (ContactLastError) to the email from the downloaded log if the email was suppressed.
Read moreRecipient5/20/2017
Added the double opt-in email subscribe form.
Read moreContact/Subscribe5/15/2017
Adjustments to the Attachment API. Added the LoadNotifications request. Bugfixes.
Read morefilename from method Attachment/Get
AttachmentLog/LoadNotificationsNotificationType5/10/2017
Added an option to set sub-account's email size limit when creating the sub-account.
Read moreemailSizeLimitto method Account/AddSubAccount5/8/2017
Added an option to load emails based on their status change date instead of the default, creation date, one.
Read moreuseStatusChangeDateto method Log/Load4/28/2017
Bugfixes
4/21/2017
Bugfixes
4/20/2017
Added option to change contacts' status to Stale depending on the amount of days that have passed since last email's open/click for the given contact. Bug fixes
Read morestaleContactInactiveDaysto method Account/UpdateAdvancedOptionsAdvancedOptions4/19/2017
Added HTTPS Tracking using the CDN service for valid Domains
Read moretrackingTypeto method Domain/AddtrackingTypeto method Domain/VerifyTracking4/11/2017
Modified the Contacts' Upload method to enable creating a list if none was found.
Read morelistNameto method Contact/Upload4/10/2017
Modified the TemplateList class to properly return a list of templates.
Read moreTemplateList3/28/2017
Replaced campaignNames parameter with channelIDs for campaigns' log export to fix commas in names messing up the export log
Read morecampaignNames from method Campaign/Export
channelIDsto method Campaign/Export3/24/2017
Modified the call's parameters to not reset skipped account's settings
Read moreAccount/UpdateAdvancedOptions3/21/2017
Removed the call to purchase a Private IP
Read moreAccount/PurchasePrivateIP
3/20/2017
Bugfixes
3/10/2017
Bugfixes, descriptions adjustments
3/9/2017
Bugfixes
3/2/2017
New method implemented: Option to load segments provided by the user instead of all segments at once.
Read moreSegment/LoadByName/Campaign/Add/Campaign/Copy| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| channelID | int | Yes | ID number of selected Channel. |
/Campaign/Delete| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| channelID | int | Yes | ID number of selected Channel. |
/Campaign/Export| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| channelIDs | List of int | No | null | List of campaign IDs used for processing |
| compressionFormat | CompressionFormat | No | ApiTypes.CompressionFormat.None | FileResponse compression format. None or Zip. |
| fileFormat | ExportFileFormats | No | ApiTypes.ExportFileFormats.Csv | Format of the exported file |
| fileName | string | No | null | Name of your file. |
/Campaign/List| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| limit | int | No | 0 | Maximum of loaded items. |
| offset | int | No | 0 | How many items should be loaded ahead. |
| search | string | No | null | Text fragment used for searching. |
/Campaign/Update/Channel/Add| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| name | string | Yes | Descriptive name of the channel |
/Channel/Delete| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| name | string | Yes | The name of the channel to delete. |
/Channel/ExportCsv| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| channelNames | List of string | Yes | List of channel names used for processing | |
| compressionFormat | CompressionFormat | No | ApiTypes.CompressionFormat.None | FileResponse compression format. None or Zip. |
| fileName | string | No | null | Name of your file. |
/Channel/ExportJson| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| channelNames | List of string | Yes | List of channel names used for processing | |
| compressionFormat | CompressionFormat | No | ApiTypes.CompressionFormat.None | FileResponse compression format. None or Zip. |
| fileName | string | No | null | Name of your file. |
/Channel/ExportXml| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| channelNames | List of string | Yes | List of channel names used for processing | |
| compressionFormat | CompressionFormat | No | ApiTypes.CompressionFormat.None | FileResponse compression format. None or Zip. |
| fileName | string | No | null | Name of your file. |
/Channel/List| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. |
/Channel/Update| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| name | string | Yes | The name of the channel to update. | |
| newName | string | Yes | The new name for the channel. |
/Contact/Add| Name | Type | Required? | Default value | Description |
| string | Yes | Proper email address. | ||
| publicAccountID | string | Yes | Public key for limited access to your account such as contact/add so you can use it safely on public websites. | |
| activationReturnUrl | string | No | null | The url to return the contact to after activation. |
| activationTemplate | string | No | null | |
| alreadyActiveUrl | string | No | null | |
| consentDate | datetime | No | null | Date of consent to send this contact(s) your email. If not provided current date is used for consent. |
| consentIP | string | No | null | IP address of consent to send this contact(s) your email. If not provided your current public IP address is used for consent. |
| field | Repeated list of string keys and string values | No | null | Custom contact field like firstname, lastname, city etc. Request parameters prefixed by field_ like field_firstname, field_lastname |
| firstName | string | No | null | First name. |
| lastName | string | No | null | Last name. |
| listName | Repeated list of string | No | null | Name of your list. |
| notifyEmail | string | No | null | Emails, separated by semicolon, to which the notification about contact subscribing should be sent to |
| publicListID | List of string | No | null | ID code of list |
| returnUrl | string | No | null | URL to navigate to after account creation |
| sendActivation | boolean | No | true | True, if you want to send activation email to this account. Otherwise, false |
| source | ContactSource | No | ApiTypes.ContactSource.ContactApi | Specifies the way of uploading the contact |
| sourceUrl | string | No | null | URL from which request was sent. |
/Contact/AddBlocked| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| string | Yes | Proper email address. | ||
| status | ContactStatus | Yes | Name of status: Active, Engaged, Inactive, Abuse, Bounced, Unsubscribed. |
/Contact/ChangeProperty| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| string | Yes | Proper email address. | ||
| name | string | Yes | Name of the contact property you want to change. | |
| value | string | Yes | Value you would like to change the contact property to. |
/Contact/ChangeStatus| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| status | ContactStatus | Yes | Name of status: Active, Engaged, Inactive, Abuse, Bounced, Unsubscribed. | |
| emails | List of string | No | null | Comma delimited list of contact emails |
| rule | string | No | null | Query used for filtering. |
/Contact/CountByStatus| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| allContacts | boolean | No | false | True: Include every Contact in your Account. Otherwise, false |
| rule | string | No | null | Query used for filtering. |
/Contact/CountByUnsubscribeReason| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| from | datetime | No | null | Starting date for search in YYYY-MM-DDThh:mm:ss format. |
| to | datetime | No | null | Ending date for search in YYYY-MM-DDThh:mm:ss format. |
/Contact/Delete| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| emails | List of string | No | null | Comma delimited list of contact emails |
| rule | string | No | null | Query used for filtering. |
/Contact/Export| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| compressionFormat | CompressionFormat | No | ApiTypes.CompressionFormat.None | FileResponse compression format. None or Zip. |
| emails | List of string | No | null | Comma delimited list of contact emails |
| fileFormat | ExportFileFormats | No | ApiTypes.ExportFileFormats.Csv | Format of the exported file |
| fileName | string | No | null | Name of your file. |
| rule | string | No | null | Query used for filtering. |
/Contact/ExportUnsubscribeReasonCount| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| compressionFormat | CompressionFormat | No | ApiTypes.CompressionFormat.None | FileResponse compression format. None or Zip. |
| fileFormat | ExportFileFormats | No | ApiTypes.ExportFileFormats.Csv | Format of the exported file |
| fileName | string | No | null | Name of your file. |
| from | datetime | No | null | Starting date for search in YYYY-MM-DDThh:mm:ss format. |
| to | datetime | No | null | Ending date for search in YYYY-MM-DDThh:mm:ss format. |
/Contact/FindContact| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| string | Yes | Proper email address. |
/Contact/GetContactsByList| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| listName | string | Yes | Name of your list. | |
| limit | int | No | 20 | Maximum of loaded items. |
| offset | int | No | 0 | How many items should be loaded ahead. |
/Contact/GetContactsBySegment| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| segmentName | string | Yes | Name of your segment. | |
| limit | int | No | 20 | Maximum of loaded items. |
| offset | int | No | 0 | How many items should be loaded ahead. |
/Contact/List| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| limit | int | No | 20 | Maximum of loaded items. |
| offset | int | No | 0 | How many items should be loaded ahead. |
| rule | string | No | null | Query used for filtering. |
/Contact/LoadBlocked| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| statuses | List of ContactStatus | Yes | List of blocked statuses: Abuse, Bounced or Unsubscribed | |
| limit | int | No | 0 | Maximum of loaded items. |
| offset | int | No | 0 | How many items should be loaded ahead. |
| search | string | No | null | Text fragment used for searching. |
/Contact/LoadContact| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| string | Yes | Proper email address. |
/Contact/LoadHistory| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| string | Yes | Proper email address. | ||
| limit | int | No | 0 | Maximum of loaded items. |
| offset | int | No | 0 | How many items should be loaded ahead. |
/Contact/QuickAdd| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| emails | List of string | Yes | Comma delimited list of contact emails | |
| consentDate | datetime | No | null | Date of consent to send this contact(s) your email. If not provided current date is used for consent. |
| consentIP | string | No | null | IP address of consent to send this contact(s) your email. If not provided your current public IP address is used for consent. |
| field | Repeated list of string keys and string values | No | null | Custom contact field like firstname, lastname, city etc. Request parameters prefixed by field_ like field_firstname, field_lastname |
| firstName | string | No | null | First name. |
| lastName | string | No | null | Last name. |
| listName | string | No | null | Name of your list. |
| notes | string | No | null | Free form field of notes |
| notifyEmail | string | No | null | Emails, separated by semicolon, to which the notification about contact subscribing should be sent to |
| publicListID | string | No | null | ID code of list |
| status | ContactStatus | No | ApiTypes.ContactStatus.Active | Name of status: Active, Engaged, Inactive, Abuse, Bounced, Unsubscribed. |
/Contact/Subscribe| Name | Type | Required? | Default value | Description |
| publicAccountID | string | Yes | Public key for limited access to your account such as contact/add so you can use it safely on public websites. |
/Contact/Update| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| string | Yes | Proper email address. | ||
| clearRestOfFields | boolean | No | true | States if the fields that were omitted in this request are to be reset or should they be left with their current value |
| customFields | string | No | null | Custom contact field like firstname, lastname, city etc. JSON serialized text like { "city":"london" } |
| field | Repeated list of string keys and string values | No | null | Custom contact field like firstname, lastname, city etc. Request parameters prefixed by field_ like field_firstname, field_lastname |
| firstName | string | No | null | First name. |
| lastName | string | No | null | Last name. |
/Contact/Upload| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| allowUnsubscribe | boolean | No | false | True: Allow unsubscribing from this (optional) newly created list. Otherwise, false |
| consentDate | datetime | No | null | Date of consent to send this contact(s) your email. If not provided current date is used for consent. |
| consentIP | string | No | null | IP address of consent to send this contact(s) your email. If not provided your current public IP address is used for consent. |
| listID | int | No | null | ID number of selected list. |
| listName | string | No | null | Name of your list to upload contacts to, or how the new, automatically created list should be named |
| status | ContactStatus | No | ApiTypes.ContactStatus.Active | Name of status: Active, Engaged, Inactive, Abuse, Bounced, Unsubscribed. |
Attach the file as POST multipart/form-data file upload or PUT file upload with content-disposition header | ||||
/Domain/Add| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| domain | string | Yes | Name of selected domain. | |
| trackingType | TrackingType | No | ApiTypes.TrackingType.Http |
/Domain/Delete| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| domain | string | Yes | Name of selected domain. |
/Domain/List| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. |
/Domain/SetDefault| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| domain | string | Yes | Default email sender, example: mail@yourdomain.com |
/Domain/VerifyDkim| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| domain | string | Yes | Name of selected domain. |
/Domain/VerifyMX| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| domain | string | Yes | Name of selected domain. |
/Domain/VerifySpf| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| domain | string | Yes | Name of selected domain. |
/Domain/VerifyTracking| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| domain | string | Yes | Name of selected domain. | |
| trackingType | TrackingType | No | ApiTypes.TrackingType.Http |
/Email/GetStatus| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| transactionID | string | Yes | Transaction identifier | |
| showAbuse | boolean | No | false | Include Reported as abuse email addresses. |
| showClicked | boolean | No | false | Include Clicked email addresses. |
| showDelivered | boolean | No | false | Include all delivered email addresses. |
| showErrors | boolean | No | false | Include error messages for bounced emails. |
| showFailed | boolean | No | false | Include Bounced email addresses. |
| showMessageIDs | boolean | No | false | Include all MessageIDs for this transaction |
| showOpened | boolean | No | false | Include Opened email addresses. |
| showPending | boolean | No | false | Include Ready to send email addresses. |
| showSent | boolean | No | false | Include Sent email addresses. |
| showUnsubscribed | boolean | No | false | Include Unsubscribed email addresses. |
/Email/Send| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| attachments | List of string | No | null | Names or IDs of attachments previously uploaded to your account that should be sent with this e-mail. |
| bodyHtml | string | No | null | Html email body |
| bodyText | string | No | null | Text email body |
| channel | string | No | null | An ID field (max 191 chars) that can be used for reporting [will default to HTTP API or SMTP API] |
| charset | string | No | null | Text value of charset encoding for example: iso-8859-1, windows-1251, utf-8, us-ascii, windows-1250 and more… |
| charsetBodyHtml | string | No | null | Sets charset for body html MIME part (overrides default value from charset parameter) |
| charsetBodyText | string | No | null | Sets charset for body text MIME part (overrides default value from charset parameter) |
| dataSource | string | No | null | |
| encodingType | EncodingType | No | ApiTypes.EncodingType.None | 0 for None, 1 for Raw7Bit, 2 for Raw8Bit, 3 for QuotedPrintable, 4 for Base64 (Default), 5 for Uue note that you can also provide the text version such as "Raw7Bit" for value 1. NOTE: Base64 or QuotedPrintable is recommended if you are validating your domain(s) with DKIM. |
| from | string | No | null | From email address |
| fromName | string | No | null | Display name for from email address |
| headers | Repeated list of string keys and string values | No | null | Optional Custom Headers. Request parameters prefixed by headers_ like headers_customheader1, headers_customheader2. Note: a space is required after the colon before the custom header value. headers_xmailer=xmailer: header-value1 |
| isTransactional | boolean | No | false | True, if email is transactional (non-bulk, non-marketing, non-commercial). Otherwise, false |
| lists | List of string | No | null | The name of a contact list you would like to send to. Separate multiple contact lists by commas or semicolons. |
| merge | Repeated list of string keys and string values | No | null | Request parameters prefixed by merge_ like merge_firstname, merge_lastname. If sending to a template you can send merge_ fields to merge data with the template. Template fields are entered with {firstname}, {lastname} etc. |
| mergeSourceFilename | string | No | null | File name one of attachments which is a CSV list of Recipients. |
| msgBcc | List of string | No | null | Optional parameter. Will be ignored if the 'to' parameter is also provided. List of email recipients (each email is treated seperately). Separated by comma or semicolon. |
| msgCC | List of string | No | null | Optional parameter. Will be ignored if the 'to' parameter is also provided. List of email recipients (visible to all other recipients of the message as CC MIME header). Separated by comma or semicolon. |
| msgFrom | string | No | null | Optional parameter. Sets FROM MIME header. |
| msgFromName | string | No | null | Optional parameter. Sets FROM name of MIME header. |
| msgTo | List of string | No | null | Optional parameter. Will be ignored if the 'to' parameter is also provided. List of email recipients (visible to all other recipients of the message as TO MIME header). Separated by comma or semicolon. |
| poolName | string | No | null | Name of your custom IP Pool to be used in the sending process |
| postBack | string | No | null | Optional header returned in notifications. |
| replyTo | string | No | null | Email address to reply to |
| replyToName | string | No | null | Display name of the reply to address |
| segments | List of string | No | null | The name of a segment you would like to send to. Separate multiple segments by comma or semicolon. Insert "0" for all Active contacts. |
| sender | string | No | null | Email address of the sender |
| senderName | string | No | null | Display name sender |
| subject | string | No | null | Email subject |
| template | string | No | null | The ID of an email template you have created in your account. |
| timeOffSetMinutes | string | No | null | Number of minutes in the future this email should be sent up to a maximum of 1 year (524160 minutes) |
| to | List of string | No | null | List of email recipients (each email is treated separately, like a BCC). Separated by comma or semicolon. We suggest using the "msgTo" parameter if backward compatibility with API version 1 is not a must. |
Attach the file as POST multipart/form-data file upload | ||||
/Email/Status| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| messageID | string | Yes | Unique identifier for this email. |
/Email/View| Name | Type | Required? | Default value | Description |
| messageID | string | Yes | Message identifier |
/Export/CheckStatus| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| publicExportID | GUID | Yes |
/Export/CountByType| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. |
/Export/Delete| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| publicExportID | GUID | Yes |
/Export/List| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| limit | int | No | 0 | Maximum of loaded items. |
| offset | int | No | 0 | How many items should be loaded ahead. |
/File/Delete| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| fileID | int | No | null | |
| filename | string | No | null | Name of your file. |
/File/Download| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| fileID | int | No | null | |
| filename | string | No | null | Name of your file. |
/File/List| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| msgID | string | Yes | ID number of selected message. |
/File/ListAll| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. |
/File/Load| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| filename | string | Yes | Name of your file. |
/File/Upload| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| expiresAfterDays | int | No | 35 | After how many days should the file be deleted. |
| name | string | No | null | Filename |
Attach the file as POST multipart/form-data file upload or PUT file upload with content-disposition header | ||||
/List/Add| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| listName | string | Yes | Name of your list. | |
| allContacts | boolean | No | false | True: Include every Contact in your Account. Otherwise, false |
| allowUnsubscribe | boolean | No | false | True: Allow unsubscribing from this list. Otherwise, false |
| createEmptyList | boolean | No | false | True to create an empty list, otherwise false. Ignores rule and emails parameters if provided. |
| emails | List of string | No | null | Comma delimited list of contact emails |
| rule | string | No | null | Query used for filtering. |
/List/AddContacts| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| listName | string | Yes | Name of your list. | |
| allContacts | boolean | No | false | True: Include every Contact in your Account. Otherwise, false |
| emails | List of string | No | null | Comma delimited list of contact emails |
| rule | string | No | null | Query used for filtering. |
/List/Copy| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| sourceListName | string | Yes | The name of the list you want to copy | |
| allowUnsubscribe | boolean | No | null | True: Allow unsubscribing from this list. Otherwise, false |
| createEmptyList | boolean | No | null | True to create an empty list, otherwise false. Ignores rule and emails parameters if provided. |
| newlistName | string | No | null | Name of your list if you want to change it. |
| rule | string | No | null | Query used for filtering. |
/List/CreateFromCampaign| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| campaignID | int | Yes | ID of the campaign which recipients you want to copy | |
| listName | string | Yes | Name of your list. | |
| statuses | List of LogJobStatus | No | null | Statuses of a campaign's emails you want to include in the new list (but NOT the contacts' statuses) |
/List/CreateNthSelectionLists| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| listName | string | Yes | Name of your list. | |
| numberOfLists | int | Yes | The number of evenly distributed lists to create. | |
| allContacts | boolean | No | false | True: Include every Contact in your Account. Otherwise, false |
| allowUnsubscribe | boolean | No | false | True: Allow unsubscribing from this list. Otherwise, false |
| excludeBlocked | boolean | No | true | True if you want to exclude contacts that are currently in a blocked status of either unsubscribe, complaint or bounce. Otherwise, false. |
| rule | string | No | null | Query used for filtering. |
/List/CreateRandomList| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| count | int | Yes | Number of items. | |
| listName | string | Yes | Name of your list. | |
| allContacts | boolean | No | false | True: Include every Contact in your Account. Otherwise, false |
| allowUnsubscribe | boolean | No | false | True: Allow unsubscribing from this list. Otherwise, false |
| excludeBlocked | boolean | No | true | True if you want to exclude contacts that are currently in a blocked status of either unsubscribe, complaint or bounce. Otherwise, false. |
| rule | string | No | null | Query used for filtering. |
/List/Delete| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| listName | string | Yes | Name of your list. |
/List/Export| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| listName | string | Yes | Name of your list. | |
| compressionFormat | CompressionFormat | No | ApiTypes.CompressionFormat.None | FileResponse compression format. None or Zip. |
| fileFormat | ExportFileFormats | No | ApiTypes.ExportFileFormats.Csv | Format of the exported file |
| fileName | string | No | null | Name of your file. |
/List/list| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| from | datetime | No | null | Starting date for search in YYYY-MM-DDThh:mm:ss format. |
| to | datetime | No | null | Ending date for search in YYYY-MM-DDThh:mm:ss format. |
/List/Load| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| listName | string | Yes | Name of your list. |
/List/MoveContacts| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| newListName | string | Yes | The name of the list to copy the contacts to | |
| oldListName | string | Yes | The name of the list from which the contacts will be copied from | |
| emails | List of string | No | null | Comma delimited list of contact emails |
| moveAll | boolean | No | null | TRUE - moves all contacts; FALSE - moves contacts provided in the 'emails' parameter. This is ignored if the 'statuses' parameter has been provided |
| rule | string | No | null | Query used for filtering. |
| statuses | List of ContactStatus | No | null | List of contact statuses which are eligible to move. This ignores the 'moveAll' parameter |
/List/RemoveContacts| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| listName | string | Yes | Name of your list. | |
| emails | List of string | No | null | Comma delimited list of contact emails |
| rule | string | No | null | Query used for filtering. |
/List/Update| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| listName | string | Yes | Name of your list. | |
| allowUnsubscribe | boolean | No | false | True: Allow unsubscribing from this list. Otherwise, false |
| newListName | string | No | null | Name of your list if you want to change it. |
/Log/CancelInProgress| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| channelName | string | No | null | Name of selected channel. |
| transactionID | string | No | null | ID number of transaction |
/Log/Export| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| statuses | List of LogJobStatus | Yes | List of comma separated message statuses: 0 for all, 1 for ReadyToSend, 2 for InProgress, 4 for Bounced, 5 for Sent, 6 for Opened, 7 for Clicked, 8 for Unsubscribed, 9 for Abuse Report | |
| channelName | string | No | null | Name of selected channel. |
| compressionFormat | CompressionFormat | No | ApiTypes.CompressionFormat.None | FileResponse compression format. None or Zip. |
| string | No | null | Proper email address. | |
| fileFormat | ExportFileFormats | No | ApiTypes.ExportFileFormats.Csv | Format of the exported file |
| fileName | string | No | null | Name of your file. |
| from | datetime | No | null | Start date. |
| includeEmail | boolean | No | true | True: Search includes emails. Otherwise, false. |
| includeSms | boolean | No | true | True: Search includes SMS. Otherwise, false. |
| messageCategory | List of MessageCategory | No | null | ID of message category |
| to | datetime | No | null | End date. |
/Log/ExportLinkTracking| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| from | datetime | Yes | Starting date for search in YYYY-MM-DDThh:mm:ss format. | |
| to | datetime | Yes | Ending date for search in YYYY-MM-DDThh:mm:ss format. | |
| channelName | string | No | null | Name of selected channel. |
| compressionFormat | CompressionFormat | No | ApiTypes.CompressionFormat.None | FileResponse compression format. None or Zip. |
| fileFormat | ExportFileFormats | No | ApiTypes.ExportFileFormats.Csv | Format of the exported file |
| fileName | string | No | null | Name of your file. |
| limit | int | No | 0 | Maximum of loaded items. |
| offset | int | No | 0 | How many items should be loaded ahead. |
/Log/LinkTracking| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| channelName | string | No | null | Name of selected channel. |
| from | datetime | No | null | Starting date for search in YYYY-MM-DDThh:mm:ss format. |
| limit | int | No | 0 | Maximum of loaded items. |
| offset | int | No | 0 | How many items should be loaded ahead. |
| to | datetime | No | null | Ending date for search in YYYY-MM-DDThh:mm:ss format. |
/Log/Load| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| statuses | List of LogJobStatus | Yes | List of comma separated message statuses: 0 for all, 1 for ReadyToSend, 2 for InProgress, 4 for Bounced, 5 for Sent, 6 for Opened, 7 for Clicked, 8 for Unsubscribed, 9 for Abuse Report | |
| channelName | string | No | null | Name of selected channel. |
| string | No | null | Proper email address. | |
| from | datetime | No | null | Starting date for search in YYYY-MM-DDThh:mm:ss format. |
| includeEmail | boolean | No | true | True: Search includes emails. Otherwise, false. |
| includeSms | boolean | No | true | True: Search includes SMS. Otherwise, false. |
| limit | int | No | 0 | Maximum of loaded items. |
| messageCategory | List of MessageCategory | No | null | ID of message category |
| offset | int | No | 0 | How many items should be loaded ahead. |
| to | datetime | No | null | Ending date for search in YYYY-MM-DDThh:mm:ss format. |
| useStatusChangeDate | boolean | No | false | True, if 'from' and 'to' parameters should resolve to the Status Change date. To resolve to the creation date - false |
/Log/LoadNotifications| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| statuses | List of LogJobStatus | Yes | List of comma separated message statuses: 0 for all, 1 for ReadyToSend, 2 for InProgress, 4 for Bounced, 5 for Sent, 6 for Opened, 7 for Clicked, 8 for Unsubscribed, 9 for Abuse Report | |
| from | datetime | No | null | Starting date for search in YYYY-MM-DDThh:mm:ss format. |
| limit | int | No | 0 | Maximum of loaded items. |
| messageCategory | List of MessageCategory | No | null | ID of message category |
| notificationType | NotificationType | No | ApiTypes.NotificationType.All | |
| offset | int | No | 0 | How many items should be loaded ahead. |
| to | datetime | No | null | Ending date for search in YYYY-MM-DDThh:mm:ss format. |
| useStatusChangeDate | boolean | No | false | True, if 'from' and 'to' parameters should resolve to the Status Change date. To resolve to the creation date - false |
/Log/RetryNow| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| msgID | string | Yes | ID number of selected message. |
/Log/Summary| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| from | datetime | Yes | Starting date for search in YYYY-MM-DDThh:mm:ss format. | |
| to | datetime | Yes | Ending date for search in YYYY-MM-DDThh:mm:ss format. | |
| channelName | string | No | null | Name of selected channel. |
| interval | IntervalType | No | ApiTypes.IntervalType.Summary | 'Hourly' for detailed information, 'summary' for daily overview |
| transactionID | string | No | null | ID number of transaction |
/Segment/Add| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| rule | string | Yes | Query used for filtering. | |
| segmentName | string | Yes | Name of your segment. |
/Segment/Copy| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| sourceSegmentName | string | Yes | The name of the segment you want to copy | |
| newSegmentName | string | No | null | New name of your segment if you want to change it. |
| rule | string | No | null | Query used for filtering. |
/Segment/Delete| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| segmentName | string | Yes | Name of your segment. |
/Segment/Export| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| segmentName | string | Yes | Name of your segment. | |
| compressionFormat | CompressionFormat | No | ApiTypes.CompressionFormat.None | FileResponse compression format. None or Zip. |
| fileFormat | ExportFileFormats | No | ApiTypes.ExportFileFormats.Csv | Format of the exported file |
| fileName | string | No | null | Name of your file. |
/Segment/List| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| from | datetime | No | null | From what date should the segment history be shown. In YYYY-MM-DDThh:mm:ss format. |
| includeHistory | boolean | No | false | True: Include history of last 30 days. Otherwise, false. |
| to | datetime | No | null | To what date should the segment history be shown. In YYYY-MM-DDThh:mm:ss format. |
/Segment/LoadByName| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| segmentNames | List of string | Yes | Names of segments you want to load. Will load all contacts if left empty or the 'All Contacts' name has been provided | |
| from | datetime | No | null | From what date should the segment history be shown. In YYYY-MM-DDThh:mm:ss format. |
| includeHistory | boolean | No | false | True: Include history of last 30 days. Otherwise, false. |
| to | datetime | No | null | To what date should the segment history be shown. In YYYY-MM-DDThh:mm:ss format. |
/Segment/Update| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| segmentName | string | Yes | Name of your segment. | |
| newSegmentName | string | No | null | New name of your segment if you want to change it. |
| rule | string | No | null | Query used for filtering. |
/SMS/Send| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| body | string | Yes | Body of your message. The maximum body length is 160 characters. If the message body is greater than 160 characters it is split into multiple messages and you are charged per message for the number of message required to send your length | |
| to | string | Yes | Mobile number you want to message. Can be any valid mobile number in E.164 format. To provide the country code you need to provide "+" before the number. If your URL is not encoded then you need to replace the "+" with "%2B" instead. |
/Survey/Add/Survey/Delete| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| publicSurveyID | GUID | Yes | Survey identifier |
/Survey/Export| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| fileName | string | Yes | Name of your file. | |
| publicSurveyID | GUID | Yes | Survey identifier | |
| compressionFormat | CompressionFormat | No | ApiTypes.CompressionFormat.None | FileResponse compression format. None or Zip. |
| fileFormat | ExportFileFormats | No | ApiTypes.ExportFileFormats.Csv | Format of the exported file |
/Survey/List| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. |
/Survey/LoadResponseList| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| publicSurveyID | GUID | Yes | Survey identifier |
/Survey/LoadResults| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| publicSurveyID | GUID | Yes | Survey identifier |
/Survey/Update/Template/Add| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| fromEmail | string | Yes | Default From: email address. | |
| fromName | string | Yes | Default From: name. | |
| name | string | Yes | Filename | |
| subject | string | Yes | Default subject of email. | |
| bodyHtml | string | No | null | HTML code of email (needs escaping). |
| bodyText | string | No | null | Text body of email. |
| css | string | No | null | CSS style |
| originalTemplateID | int | No | 0 | ID number of original template. |
| templateScope | TemplateScope | No | ApiTypes.TemplateScope.Private | Enum: 0 - private, 1 - public, 2 - mockup |
| templateType | TemplateType | No | ApiTypes.TemplateType.RawHTML | 0 for API connections |
/Template/CheckUsage| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| templateID | int | Yes | ID number of template. |
/Template/Copy| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| fromEmail | string | Yes | Default From: email address. | |
| fromName | string | Yes | Default From: name. | |
| name | string | Yes | Filename | |
| subject | string | Yes | Default subject of email. | |
| templateID | int | Yes | ID number of template. |
/Template/Delete| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| templateID | int | Yes | ID number of template. |
/Template/GetEmbeddedHtml| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| templateID | int | Yes | ID number of template. |
/Template/GetList| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| limit | int | No | 500 | Maximum of loaded items. |
| offset | int | No | 0 | How many items should be loaded ahead. |
/Template/LoadTemplate| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| templateID | int | Yes | ID number of template. | |
| ispublic | boolean | No | false |
/Template/RemoveScreenshot| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| templateID | int | Yes | ID number of template. |
/Template/SaveScreenshot| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| base64Image | string | Yes | Image, base64 coded. | |
| templateID | int | Yes | ID number of template. |
/Template/Update| Name | Type | Required? | Default value | Description |
| apikey | string | Yes | ApiKey that gives you access to our SMTP and HTTP API's. Available here. | |
| templateID | int | Yes | ID number of template. | |
| bodyHtml | string | No | null | HTML code of email (needs escaping). |
| bodyText | string | No | null | Text body of email. |
| css | string | No | null | CSS style |
| fromEmail | string | No | null | Default From: email address. |
| fromName | string | No | null | Default From: name. |
| name | string | No | null | Filename |
| removeScreenshot | boolean | No | true | |
| subject | string | No | null | Default subject of email. |
| templateScope | TemplateScope | No | ApiTypes.TemplateScope.Private | Enum: 0 - private, 1 - public, 2 - mockup |
| Properties | Description | Example | Type |
|---|---|---|---|
| AccountPaymentUrl | URL for making payments. | http://payments.yourdomain.com | string |
| Address1 | First line of address. | ADDRESS1 | string |
| Address2 | Second line of address. | ADDRESS2 | string |
| AffiliateLink | URL for affiliating. | http:// | string |
| ApiKey | ApiKey that gives you access to our SMTP and HTTP API's. | 94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3 | string |
| ApiKey2 | Second ApiKey that gives you access to our SMTP and HTTP API's. Used mainly for changing ApiKeys without disrupting services. | BE4C7ECC-5176-44B4-A843-EE704BCB1B51 | string |
| AutoCreditAmount | When AutoCreditStatus is Enabled, the amount of credit to be recharged. | 500 | decimal |
| AutoCreditLevel | When AutoCreditStatus is Enabled, the credit level that triggers the credit to be recharged. | 100 | decimal |
| AutoCreditStatus | Status of automatic payments configuration. | Off | string |
| City | City. | CITY | string |
| Company | Company name. | COMPANY | string |
| ContentTransferEncoding | Type of content encoding | Base64 | string |
| CountryID | Numeric ID of country. A file with the list of countries is available here | 12345 | int |
| Credit | Amount of emails sent from this account | 1000 | decimal |
| DailySendLimit | Amount of emails account can send daily | 100000 | int |
| DateCreated | Creation date. | 2001-01-01:12:00:00 | datetime |
| DeliveryReason | Why your clients are receiving your emails. | Reason | string |
| DomainRestricted | boolean | ||
| Proper email address. | mail@example.com | string | |
| EmailCredits | Amount of email credits | 1000 | int |
| EnableBouncesHandling | boolean | ||
| EnableContactFeatures | Enable contact delivery and optimization tools on your Account. | boolean | |
| EnablePrivateBranding | True: Turn on or off ability to send mails under your brand. Otherwise, false | true | boolean |
| FirstName | First name. | FIRSTNAME | string |
| IsSub | True, if account is a subaccount. Otherwise, false | false | boolean |
| LastName | Last name. | LASTNAME | string |
| LinkTracking | True, if you have enabled link tracking. Otherwise, false | true | boolean |
| LitmusCredits | Amount of Litmus credits | 1000 | decimal |
| LogoUrl | URL to your logo image. | http://yourdomain.com/logo.png | string |
| MonthlyEmailsSent | Amount of emails sent from this account | 1000 | long |
| NeedsSMSVerification | boolean | ||
| PaymentFormUrl | URL form for payments. | http:// | string |
| Phone | Phone number | 1234567890 | string |
| PricePerEmail | Amount of emails sent from this account | 1000 | decimal |
| PrivateBrandingUrl | Subdomain for your rebranded service | mailing.yourdomain.com | string |
| PublicAccountID | Public key for limited access to your account such as contact/add so you can use it safely on public websites. | EB3EBB7A-C20D-4D39-8F2F-5E6842F58E6F | string |
| Reputation | Numeric reputation | 100 | double |
| Smtp | Address of SMTP server. | smtp.yourdomain.com | string |
| SmtpAlternative | Address of alternative SMTP server. | smtp2.yourdomain.com | string |
| State | State or province. | STATE | string |
| StatusFormatted | Account status: Active | Active | string |
| StatusNumber | Number of status: 1 - Active | 1 | int |
| SubAccountsCount | The number of subaccounts this account has. | 1 | long |
| SupportLink | Address to your support. | http://help.yourdomain.com | string |
| TaxCode | Code used for tax purposes. | string | |
| TotalEmailsSent | Amount of emails sent from this account | 1000 | long |
| Website | HTTP address of your website. | http://example.com | string |
| Zip | Zip/postal code. | ZIP/POSTAL | string |
| Properties | Description | Example | Type |
|---|---|---|---|
| BlockedContactsCount | Number of contacts currently with blocked status of Unsubscribed, Complaint, Bounced or InActive | 1000 | long |
| CampaignCount | Number of created campaigns | 10 | long |
| ContactCount | Number of contacts | 10000 | long |
| CostPerThousand | Cost of 1000 emails | 0.09 | decimal |
| Credit | Amount of emails sent from this account | 1000 | decimal |
| InProgressCount | Number of messages in progress | 1234 | long |
| ReferralCount | Number of active referrals | 10 | long |
| Reputation | Numeric reputation | 100 | double |
| SubAccountCount | Number of created subaccounts | 10 | long |
| TemplateCount | Number of available templates | 10 | long |
| TotalEmailsSent | Amount of emails sent from this account | 1000 | long |
| Values | Value | Description |
|---|---|---|
| NotEnoughCredits | 1 | Account doesn't have enough credits |
| CanSendEmailsNoAttachments | 2 | Account can send e-mails but only without the attachments |
| DailySendLimitExceeded | 3 | Account has exceeded his daily send limit |
| CanSendEmails | 4 | Account is ready to send e-mails |
| Properties | Description | Example | Type |
|---|---|---|---|
| AllowCustomHeaders | True, if you want to apply custom headers to your emails. Otherwise, false | true | boolean |
| AutoTextFormat | True, if text BODY of message should be created automatically. Otherwise, false | true | boolean |
| BccEmail | Email address to send a copy of all email to. | your@email.com | string |
| ContentTransferEncoding | Type of content encoding | Base64 | string |
| DeliveryReason | Why your clients are receiving your emails. | Reason | string |
| EmailNotification | True, if you want to receive bounce email notifications. Otherwise, false | true | string |
| EmailNotificationForError | True, if you want bounce notifications returned. Otherwise, false | false | boolean |
| EnableClickTracking | True, if you want to track clicks. Otherwise, false | true | boolean |
| EnableContactFeatures | True, if you want to use Contact Delivery Tools. Otherwise, false | boolean | |
| EnableLinkClickTracking | True, if you want to track by link tracking. Otherwise, false | true | boolean |
| EnableTemplateScripting | True, if you want to use template scripting in your emails {{}}. Otherwise, false | true | boolean |
| EnableUITooltips | True, if account has tooltips active. Otherwise, false | true | boolean |
| EnableUnsubscribeHeader | True, if you want to enable list-unsubscribe header. Otherwise, false | true | boolean |
| HubCallbackUrl | URL used for tracking action of inbound emails | http:// | string |
| InboundContactsOnly | True, if you want inbound email to only process contacts from your account. Otherwise, false | true | boolean |
| InboundDomain | Domain you use as your inbound domain | yourdomain.com | string |
| IsOwnedByReseller | True, if this account resells Doali. Otherwise, false. | false | boolean |
| IsSubAccount | True, if this account is a sub-account. Otherwise, false | true | boolean |
| LogoUrl | URL to your logo image. | http://yourdomain.com/logo.png | string |
| LowCreditNotification | True, if you want to receive low credit email notifications. Otherwise, false | true | boolean |
| ManageSubscribedOnly | True, if you want to only display labels that the contact is subscribed to on your unsubscribe form. Otherwise, false | true | boolean |
| ManageSubscriptions | True, if you want to display your labels on your unsubscribe form. Otherwise, false | true | boolean |
| NotificationsEmails | Email addresses to send a copy of all notifications from our system. Separated by semicolon | email1@example.com;email2@example.com | string |
| PreviewMessageID | string | ||
| StaleContactInactiveDays | (0 means this functionality is NOT enabled) Number of days of inactivity for a contact after which the given recipient should be moved to the Stale status | 180 | int |
| StaleContactScore | (0 means this functionality is NOT enabled) Score, depending on the number of times you have sent to a recipient, at which the given recipient should be moved to the Stale status | -4 | int |
| TransactionalOnUnsubscribe | True, if you want to display an option for the contact to opt into transactional email only on your unsubscribe form. Otherwise, false | true | boolean |
| UnsubscribeNotificationEmails | Emails, separated by semicolon, to which the notification about contact unsubscribing should be sent to | email1@example.com;email2@example.com | string |
| WebNotificationForAbuse | True, if you want to send web notifications for complaint email. Otherwise, false | true | boolean |
| WebNotificationForClicked | True, if you want to send web notifications for clicked email. Otherwise, false | true | boolean |
| WebNotificationForError | True, if you want to send web notifications for bounced email. Otherwise, false | true | boolean |
| WebNotificationForOpened | True, if you want to send web notifications for opened email. Otherwise, false | true | boolean |
| WebNotificationForSent | True, if you want to send web notifications for sent email. Otherwise, false | true | boolean |
| WebnotificationForUnsubscribed | True, if you want to send web notifications for unsubscribed email. Otherwise, false | true | boolean |
| WebNotificationNotifyOncePerEmail | True, if you want to receive notifications for each type only once per email. Otherwise, false | true | boolean |
| WebNotificationUrl | URL address to receive web notifications to parse and process. | http:// | string |
| Values | Value | Description |
|---|---|---|
| Add | 1 | Add an additional APIKey to your Account. |
| Change | 2 | Change this APIKey to a new one. |
| Delete | 3 | Delete this APIKey |
| Properties | Description | Example | Type |
|---|---|---|---|
| DateUpdated | Last change date | 2001-01-01:12:00:00 | string |
| Proper email address. | mail@example.com | string | |
| FriendlyErrorMessage | RFC error message | Mailbox not found | string |
| Status | Name of status: Active, Engaged, Inactive, Abuse, Bounced, Unsubscribed. | Bounced | string |
| Properties | Description | Example | Type |
|---|---|---|---|
| AccountProblem | Number of messages flagged with 'Account Problem' | 0 | long |
| BlackListed | Number of blacklisted messages | 1000 | long |
| CodeError | Number of messages flagged with 'Code Error' | 0 | long |
| ConnectionProblem | Number of messages flagged with 'Connection Problem' | 0 | long |
| ConnectionTerminated | Number of messages flagged with 'Connection terminated' | 0 | long |
| DnsProblem | Number of messages flagged with 'DNS Problem' | 0 | long |
| GreyListed | Number of messages flagged with 'Grey Listed' | 0 | long |
| ManualCancel | Number of manually cancelled messages | 1000 | long |
| NoMailbox | Number of messages flagged with 'No Mailbox' | 0 | long |
| NotDelivered | Number of messages flagged with 'Not Delivered' | 0 | long |
| Spam | Number of messages marked as SPAM | 1000 | long |
| SpfProblem | Number of messages flagged with 'SPF Problem' | 0 | long |
| Throttled | Number of messages flagged with 'Throttled' | 0 | long |
| Timeout | Number of messages flagged with 'Timeout' | 0 | long |
| WhitelistingProblem | Number of messages flagged with 'WhiteListing Problem' | 0 | long |
| Properties | Description | Example | Type |
|---|---|---|---|
| CampaignTemplates | List of CampaignTemplate | ||
| ChannelID | ID number of selected Channel. | 123456 | int |
| Name | Campaign's name | string | |
| SplitOptimization | What should be checked for choosing the winner: opens or clicks | 0 | SplitOptimization |
| SplitOptimizationMinutes | Number of minutes between sends during optimization period | 30 | int |
| Status | Name of campaign's status | CampaignStatus | |
| Targets | List of Segment and List IDs, preceded with 'l' for Lists and 's' for Segments, comma separated | s01,l10 | Repeated list of string |
| TimingOption | int | ||
| TriggerChannelID | ID number of transaction | TransactionID | int |
| TriggerCount | How many times should the campaign be sent | 1 | int |
| TriggerData | Data for filtering event campaigns such as specific link addresses. | string | |
| TriggerDate | Date of triggered send | 2001-01-01T12:00:00 | datetime |
| TriggerDelay | How far into the future should the campaign be sent, in minutes | 20 | double |
| TriggerFrequency | When your next automatic mail will be sent, in minutes | 30 | double |
| TriggerType | Number of event, triggering mail sending | 1 | CampaignTriggerType |
| Properties | Description | Example | Type |
|---|---|---|---|
| ChannelID | ID number of selected Channel. | 123456 | int |
| ClickedCount | Total emails clicked | 1000 | int |
| DateAdded | Date of creation in YYYY-MM-DDThh:ii:ss format | 2001-01-01T12:00:00 | datetime |
| FailedAbuse | Abuses - mails sent to user without their consent | 0.00 | int |
| FailedCount | Total emails sent. | 1000 | int |
| IsCampaign | True, if you are sending a campaign. Otherwise, false. | True | boolean |
| LastActivity | Date of last activity on account | 2001-01-01T12:00:00 | datetime |
| LastProcessed | Datetime of last action done on campaign. | 2001-01-01T01:01:01 | datetime |
| Name | Filename | attachment.txt | string |
| OpenedCount | Total emails opened. | 1000 | int |
| ParentChannelID | Id number of parent channel | 123456 | int |
| PoolName | Name of your custom IP Pool to be used in the sending process | My Custom Pool | string |
| RecipientCount | Overall number of recipients | 1000 | int |
| SentCount | Total emails sent. | 1000 | int |
| SplitOptimization | What should be checked for choosing the winner: opens or clicks | 0 | SplitOptimization |
| SplitOptimizationMinutes | Number of minutes between sends during optimization period | 30 | int |
| Status | Name of campaign's status | CampaignStatus | |
| Targets | List of Segment and List IDs, preceded with 'l' for Lists and 's' for Segments, comma separated | s01,l10 | Repeated list of string |
| TemplateChannels | List of CampaignTemplate for sending A-X split testing. | CampaignTemplate1, CampaignTemplate2 | List of CampaignChannel |
| TemplateFromEmail | Default From: email address. | sender@yourdomain.com | string |
| TemplateFromName | Default From: name. | Sender | string |
| TemplateID | ID number of template. | 1234 | int |
| TemplateReplyEmail | Default Reply: email address. | replyto@yourdomain.com | string |
| TemplateReplyName | Default Reply: name. | Reply | string |
| TemplateSubject | Default subject of email. | Hello! | string |
| TimingOption | int | ||
| TriggerChannelID | ID number of transaction | TransactionID | int |
| TriggerCount | How many times should the campaign be sent | 1 | int |
| TriggerData | Data for filtering event campaigns such as specific link addresses. | string | |
| TriggerDate | Date of triggered send | 2001-01-01T12:00:00 | datetime |
| TriggerDelay | How far into the future should the campaign be sent, in minutes | 20 | double |
| TriggerFrequency | When your next automatic mail will be sent, in minutes | 30 | double |
| TriggerType | Number of event, triggering mail sending | 1 | CampaignTriggerType |
| UnsubscribedCount | Total emails clicked | 1000 | int |
| Values | Value | Description |
|---|---|---|
| Deleted | -1 | Campaign is logically deleted and not returned by API or interface calls. |
| Active | 0 | Campaign is curently active and available. |
| Processing | 1 | Campaign is currently being processed for delivery. |
| Sending | 2 | Campaign is currently sending. |
| Completed | 3 | Campaign has completed sending. |
| Paused | 4 | Campaign is currently paused and not sending. |
| Cancelled | 5 | Campaign has been cancelled during delivery. |
| Draft | 6 | Campaign is save as draft and not processing. |
| Properties | Description | Example | Type |
|---|---|---|---|
| ChannelID | ID number of selected Channel. | 123456 | int |
| PoolName | Name of your custom IP Pool to be used in the sending process | My Custom Pool | string |
| Status | Name of campaign's status | CampaignStatus | |
| TemplateFromEmail | Default From: email address. | sender@yourdomain.com | string |
| TemplateFromName | Default From: name. | Sender | string |
| TemplateID | ID number of template. | 1234 | int |
| TemplateReplyEmail | Default Reply: email address. | replyto@yourdomain.com | string |
| TemplateReplyName | Default Reply: name. | Reply | string |
| TemplateSubject | Default subject of email. | Hello! | string |
| Values | Value | Description |
|---|---|---|
| SendNow | 1 | |
| FutureScheduled | 2 | |
| OnAdd | 3 | |
| OnOpen | 4 | |
| OnClick | 5 |
| Values | Value | Description |
|---|---|---|
| ErrorOccured | -2 | |
| CertNotSet | 0 | |
| Valid | 1 | |
| NotValid | 2 |
| Properties | Description | Example | Type |
|---|---|---|---|
| ClickedCount | The number of emails that have been clicked within this channel. | int | |
| Cost | The total cost for emails/attachments within this channel. | decimal | |
| DateAdded | The date the channel was added to your account. | datetime | |
| FailedAbuse | The number of emails that have been marked as abuse or complaint within this channel. | int | |
| FailedCount | The number of emails that have been bounced within this channel. | int | |
| JobCount | The number of email jobs this channel has been used with. | int | |
| LastActivity | The date the channel was last sent through. | datetime | |
| Name | Descriptive name of the channel. | string | |
| OpenedCount | The number of emails that have been opened within this channel. | int | |
| RecipientCount | The number of emails attempted to be sent within this channel. | int | |
| SentCount | The number of emails that have been sent within this channel. | int | |
| UnsubscribedCount | The number of emails that have been unsubscribed within this channel. | int |
| Values | Value | Description |
|---|---|---|
| None | 0 | No compression |
| Zip | 1 | Zip compression |
| Properties | Description | Example | Type |
|---|---|---|---|
| BouncedErrorCode | RFC Error code | 550 | int |
| BouncedErrorMessage | RFC error message | Mailbox not found | string |
| ContactScore | int | ||
| CreatedFromIP | IP address | 192.168.0.1 | string |
| CustomFields | Custom contact field like firstname, lastname, city etc. JSON serialized text like { "city":"london" } | english | Repeated list of string keys and string values |
| DateAdded | Date of creation in YYYY-MM-DDThh:ii:ss format | 2001-01-01T12:00:00 | datetime |
| DateUpdated | Last change date | 2001-01-01:12:00:00 | datetime |
| Proper email address. | mail@example.com | string | |
| ErrorCode | RFC Error code | 550 | int |
| FirstFailedDate | Date of first failed message | 2001-01-01:12:00:00 | datetime |
| FirstName | First name. | FIRSTNAME | string |
| FriendlyErrorMessage | RFC error message | Mailbox not found | string |
| LastClicked | datetime | ||
| LastFailedCount | Number of fails in sending to this Contact | 1 | int |
| LastName | Last name. | LASTNAME | string |
| LastOpened | Date this contact last opened an email | 2014-01-01 | datetime |
| Notes | Free form field of notes | Contact is extremely important! | string |
| Source | Source of URL of payment | http:// | ContactSource |
| Status | Name of status: Active, Engaged, Inactive, Abuse, Bounced, Unsubscribed. | Bounced | ContactStatus |
| TotalClicked | Total emails clicked | 1000 | int |
| TotalFailed | Total emails sent. | 1000 | int |
| TotalOpened | Total emails opened. | 1000 | int |
| TotalSent | Total emails sent. | 1000 | int |
| UnsubscribedDate | Unsubscribed date in YYYY-MM-DD format | 2001-01-01 | datetime |
| WebsiteUrl | Website of contact | http:// | string |
| Properties | Description | Example | Type |
|---|---|---|---|
| Lists | Lists which contain the requested contact | List of ContactContainer | |
| Segments | Segments which contain the requested contact | List of ContactContainer |
| Properties | Description | Example | Type |
|---|---|---|---|
| ID | ID of the list/segment | int | |
| Name | Name of the list/segment | string |
| Values | Value | Description |
|---|---|---|
| Opened | 2 | Contact opened an e-mail |
| Clicked | 3 | Contact clicked an e-mail |
| Bounced | 10 | E-mail sent to the contact bounced |
| Unsubscribed | 11 | Contact unsubscribed |
| Complained | 12 | Contact complained to an e-mail |
| Activated | 20 | Contact clicked an activation link |
| TransactionalUnsubscribed | 21 | Contact has opted to receive Transactional-only e-mails |
| ManualStatusChange | 22 | Contact's status was changed manually |
| ActivationSent | 24 | An Activation e-mail was sent |
| Deleted | 28 | Contact was deleted |
| Properties | Description | Example | Type |
|---|---|---|---|
| ChannelName | Name of selected channel. | Channel01 | string |
| ContactHistoryID | ID of history of selected Contact. | 123456 | long |
| Country | Country of the event. | string | |
| Data | Information about the event | string | |
| EventDate | Formatted date of event. | 1/1/2015 0:00:00 AM | string |
| EventType | Type of event occured on this Contact. | Sent | string |
| EventTypeValue | Numeric code of event occured on this Contact. | 1 | ContactHistEventType |
| IPAddress | IP Address of the event. | string | |
| TemplateName | Name of template. | Template01 | string |
| Values | Value | Description |
|---|---|---|
| DeliveryApi | 0 | Source of the contact is from sending an email via our SMTP or HTTP API's |
| ManualInput | 1 | Contact was manually entered from the interface. |
| FileUpload | 2 | Contact was uploaded via a file such as CSV. |
| WebForm | 3 | Contact was added from a public web form. |
| ContactApi | 4 | Contact was added from the contact api. |
| Values | Value | Description |
|---|---|---|
| Transactional | -2 | Only transactional email can be sent to contacts with this status. |
| Engaged | -1 | Contact has had an open or click in the last 6 months. |
| Active | 0 | Contact is eligible to be sent to. |
| Bounced | 1 | Contact has had a hard bounce and is no longer eligible to be sent to. |
| Unsubscribed | 2 | Contact has unsubscribed and is no longer eligible to be sent to. |
| Abuse | 3 | Contact has complained and is no longer eligible to be sent to. |
| Inactive | 4 | Contact has not been activated or has been de-activated and is not eligible to be sent to. |
| Stale | 5 | Contact has not been opening emails for a long period of time and is not eligible to be sent to. |
| NotConfirmed | 6 | Contact has not confirmed their double opt-in activation and is not eligible to be sent to. |
| Properties | Description | Example | Type |
|---|---|---|---|
| Active | Number of active contacts | 1000 | long |
| Bounced | Number of bounced messages | 1000 | long |
| Complaint | Number of complaint messages | 1000 | long |
| Engaged | Number of engaged contacts | 1000 | long |
| Inactive | Number of inactive contacts | 1000 | long |
| NotConfirmed | long | ||
| Stale | long | ||
| Transactional | Number of transactional contacts | 1000 | long |
| Unsubscribed | Number of unsubscribed messages | 1000 | long |
| Properties | Description | Example | Type |
|---|---|---|---|
| AbuseReported | long | ||
| DeceptiveContent | long | ||
| IrrelevantContent | long | ||
| ListUnsubscribe | long | ||
| NeverConsented | long | ||
| NoLongerWant | long | ||
| ThirdParty | long | ||
| TooFrequent | long | ||
| Unknown | long |
| Values | Value | Description |
|---|---|---|
| 9 | Used to send emails. One credit = one email. | |
| Litmus | 11 | Used to run a litmus test on a template. 1 credit = 1 test. |
| Properties | Description | Example | Type |
|---|---|---|---|
| Bounced |