API Documentation

Welcome to the Doali Email 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 Email Dashboard and additional calls that may be required for tight integration with our Email services.

Most of API requests can be sent using HTTP GET or POST methods. 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
Use	Base URL	Path	Parameters
Doali Email	https://api.doali.com	/v2/category/action	?param1=value1&param2=value2
Private Branding*	https://api.yourdomain.com	/v2/category/action	?param1=value1&param2=value2
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:

Send an Email
Submit a Campaign
Export a Log
Send an SMS

Interface Libraries for this API have been written for several languages. Access them along with code samples here: http://help.api.doali.com/api/integration-libraries

AccessToken
Manage your AccessTokens (ApiKeys)

Add

`/AccessToken/Add`

Add new AccessToken with appropriate AccessLevel (permission).

Parameters

Security

Access Level

Name	Type	Required?	Default value	Description
accessLevel	AccessLevel	Yes		Level of access (permission) to our API.
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
tokenName	string	Yes		Name of the AccessToken for ease of reference. If you want to create a SMTP access, then tokenname must be a valid email address
expires	datetime	No	null
restrictAccessToIPRange	List of string	No	null	Comma separated list of CIDR notated IP ranges that this token can connect from.
type	AccessTokenType	No	ApiTypes.AccessTokenType.APIKey

Returns

{"success": true, "data": AccessToken key } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/accesstoken/add?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&tokenName=My Token&accessLevel=&restrictAccessToIPRange=1.1.1.1/32,2.2.2.2/24&type=&expires=

Delete

`/AccessToken/Delete`

Permanently delete AccessToken from your Account.

Parameters

Security

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
tokenName	string	Yes		Name of the AccessToken for ease of reference. If you want to create a SMTP access, then tokenname must be a valid email address
type	AccessTokenType	No	null

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/accesstoken/delete?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&tokenName=My Token&type=

List

`/AccessToken/List`

List all the AccessToken's in your Account.

Parameters

Security

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.

Returns

{"success": true, "data": { List of AccessToken } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/accesstoken/list?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW

Update

`/AccessToken/Update`

Update AccessToken with a new name or AccessLevel.

Parameters

Security

Access Level

Name	Type	Required?	Default value	Description
accessLevel	AccessLevel	Yes		Level of access (permission) to our API.
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
expires	datetime	Yes
tokenName	string	Yes		Name of the AccessToken for ease of reference. If you want to create a SMTP access, then tokenname must be a valid email address
newTokenName	string	No	null	New name of the AccessToken.
restrictAccessToIPRange	List of string	No	null	Comma separated list of CIDR notated IP ranges that this token can connect from.
type	AccessTokenType	No	null

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/accesstoken/update?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&tokenName=My Token&accessLevel=&expires=&newTokenName=My Token&restrictAccessToIPRange=1.1.1.1/32,2.2.2.2/24&type=

Account
Methods for managing your account and subaccounts.

AddDedicatedSupport

`/Account/AddDedicatedSupport`

Request premium support for your account

Parameters

ModifyBilling

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
supportPlan	SupportPlan	Yes

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/adddedicatedsupport?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&supportPlan=

AddSubAccount

`/Account/AddSubAccount`

Create new subaccount and provide most important data about it.

Parameters

ModifySubAccounts

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
confirmPassword	string	Yes		Repeat the password
email	string	Yes		Proper email address.
password	string	Yes		Password
allow2fa	boolean	No	false	True, if you want to allow two-factor authentication. Otherwise, false.
dailySendLimit	int	No	null	Amount of emails Account can send daily
emailSizeLimit	int	No	10	Maximum size of email including attachments in MB's
enableContactFeatures	boolean	No	null	True, if you want to use Contact Delivery Tools. Otherwise, false
enablePrivateIPRequest	boolean	No	true	True, if Account can request for private IP on its own. Otherwise, false
maxContacts	int	No	0	Maximum number of contacts the Account can have
poolName	string	No	null	Private IP required. Name of the custom IP Pool which Sub Account should use to send its emails. Leave empty for the default one or if no Private IPs have been bought
requiresEmailCredits	boolean	No	false	True, if Account needs credits to send emails. Otherwise, false
returnUrl	string	No	null	URL to navigate to after Account creation
sendActivation	boolean	No	false	True, if you want to send activation email to this Account. Otherwise, false
sendingPermission	SendingPermission	No	null	Sending permission setting for Account
validSenderDomainOnly	boolean	No	null

Returns

{"success": true, "data": string } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/addsubaccount?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&email=mail@example.com&password=&confirmPassword=&allow2fa=&requiresEmailCredits=true&maxContacts=100000&enablePrivateIPRequest=true&sendActivation=false&returnUrl=http://yourdomain.com&sendingPermission=All&enableContactFeatures=&poolName=&emailSizeLimit=10&dailySendLimit=100000&validSenderDomainOnly=

AddSubAccountCredits

`/Account/AddSubAccountCredits`

Add email credits to a sub-account

Parameters

ModifySubAccounts

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
credits	int	Yes		Amount of credits to add
notes	string	Yes		Specific notes about the transaction
publicAccountID	string	No	null	Public key of sub-account to add credits to. Use subAccountEmail or publicAccountID not both.
subAccountEmail	string	No	null	Email address of Sub-Account

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/addsubaccountcredits?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&credits=&notes=&subAccountEmail=mail@example.com&publicAccountID=

AddWebhook

`/Account/AddWebhook`

Add notifications webhook

Parameters

ModifyWebNotifications

Access Level

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		Filename
webNotificationUrl	string	Yes		URL address to receive web notifications to parse and process.
notificationForAbuseReport	boolean	No	null
notificationForClicked	boolean	No	null
notificationForError	boolean	No	null
notificationForOpened	boolean	No	null
notificationForSent	boolean	No	null
notificationForUnsubscribed	boolean	No	null
notifyOncePerEmail	boolean	No	null

Returns

{"success": true, "data": string } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/addwebhook?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&webNotificationUrl=http://&name=attachment.txt&notifyOncePerEmail=&notificationForSent=&notificationForOpened=&notificationForClicked=&notificationForUnsubscribed=&notificationForAbuseReport=&notificationForError=

ChangeEmail

`/Account/ChangeEmail`

Change your email address. Remember, that your email address is used as login!

Parameters

Security

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
confirmEmail	string	Yes		New email address.
newEmail	string	Yes		New email address.
sourceUrl	string	No	null	URL from which request was sent.

Returns

{"success": true, "data": Notification about e-mail confirmation } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/changeemail?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&newEmail=newmail@example.com&confirmEmail=newmail@example.com&sourceUrl=http://source.url.com

ChangePassword

`/Account/ChangePassword`

Create new password for your account. Password needs to be at least 6 characters long.

Parameters

Security

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
confirmPassword	string	Yes		Repeat new password.
newPassword	string	Yes		New password for Account.
currentPassword	string	No	null	Current password.
expireDashboardSessions	boolean	No	false

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/changepassword?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&newPassword=********&confirmPassword=********&expireDashboardSessions=&currentPassword=********

ChangeSubAccountPassword

`/Account/ChangeSubAccountPassword`

Create new password for subaccount. Password needs to be at least 6 characters long.

Parameters

Security

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
confirmPassword	string	Yes		Repeat new password.
newPassword	string	Yes		New password for Account.
subAccountEmail	string	Yes		Email address of Sub-Account
expireDashboardSessions	boolean	No	false

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/changesubaccountpassword?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&newPassword=********&confirmPassword=********&subAccountEmail=mail@example.com&expireDashboardSessions=

DeleteSubAccount

`/Account/DeleteSubAccount`

Deletes specified Subaccount

Parameters

ModifySubAccounts

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
publicAccountID	string	No	null	Public key of sub-account to delete. Use subAccountEmail or publicAccountID not both.
subAccountEmail	string	No	null	Email address of Sub-Account

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/deletesubaccount?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&subAccountEmail=mail@example.com&publicAccountID=

DeleteWebhook

`/Account/DeleteWebhook`

Delete notifications webhook

Parameters

ModifyWebNotifications

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
webhookID	string	Yes

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/deletewebhook?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&webhookID=

GetSubAccountList

`/Account/GetSubAccountList`

Lists all of your subaccounts

Parameters

ViewSubAccounts

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
countContacts	boolean	No	true
email	string	No	null	Proper email address.
limit	int	No	0	Maximum number of returned items.
offset	int	No	0	How many items should be returned ahead.

Returns

{"success": true, "data": { List of SubAccount } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/getsubaccountlist?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&limit=100&offset=20&email=mail@example.com&countContacts=

Load

`/Account/Load`

Loads your account. Returns detailed information about your account.

Parameters

ViewAccount

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.

Returns

{"success": true, "data": { Account } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/load?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW

LoadAdvancedOptions

`/Account/LoadAdvancedOptions`

Load advanced options of your account

Parameters

ViewSettings

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.

Returns

{"success": true, "data": { AdvancedOptions } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/loadadvancedoptions?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW

LoadEmailCreditsHistory

`/Account/LoadEmailCreditsHistory`

Lists email credits history

Parameters

ViewBilling

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.

Returns

{"success": true, "data": { List of EmailCredits } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/loademailcreditshistory?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW

LoadInboundOptions

`/Account/LoadInboundOptions`

Load inbound options of your account

Parameters

ViewSettings

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.

Returns

{"success": true, "data": { InboundOptions } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/loadinboundoptions?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW

LoadPaymentHistory

`/Account/LoadPaymentHistory`

Lists all payments

Parameters

ViewBilling

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
fromDate	datetime	Yes		Starting date for search in YYYY-MM-DDThh:mm:ss format.
limit	int	Yes		Maximum number of returned items.
offset	int	Yes		How many items should be returned ahead.
toDate	datetime	Yes		Ending date for search in YYYY-MM-DDThh:mm:ss format.

Returns

{"success": true, "data": { List of Payment } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/loadpaymenthistory?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&limit=100&offset=20&fromDate=2001-01-01T01:01:01&toDate=2001-01-01T01:01:01

LoadPayoutHistory

`/Account/LoadPayoutHistory`

Lists all referral payout history

Parameters

ViewBilling

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.

Returns

{"success": true, "data": { List of Payment } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/loadpayouthistory?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW

LoadReferralDetails

`/Account/LoadReferralDetails`

Shows information about your referral details

Parameters

ViewBilling

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.

Returns

{"success": true, "data": { Referral } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/loadreferraldetails?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW

LoadReputationHistory

`/Account/LoadReputationHistory`

Shows latest changes in your sending reputation

Parameters

ViewAccount

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.

Returns

{"success": true, "data": { List of ReputationHistory } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/loadreputationhistory?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW

LoadReputationImpact

`/Account/LoadReputationImpact`

Shows detailed information about your actual reputation score

Parameters

ViewAccount

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.

Returns

{"success": true, "data": { ReputationDetail } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/loadreputationimpact?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW

LoadSpamCheck

`/Account/LoadSpamCheck`

Returns detailed spam check.

Parameters

ViewAccount

Access Level

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 number of returned items.
offset	int	No	0	How many items should be returned ahead.

Returns

{"success": true, "data": { List of SpamCheck } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/loadspamcheck?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&limit=100&offset=20

LoadSubAccountsEmailCreditsHistory

`/Account/LoadSubAccountsEmailCreditsHistory`

Lists email credits history for sub-account

Parameters

ViewSubAccounts

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
publicAccountID	string	No	null	Public key of sub-account to list history for. Use subAccountEmail or publicAccountID not both.
subAccountEmail	string	No	null	Email address of Sub-Account

Returns

{"success": true, "data": { List of EmailCredits } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/loadsubaccountsemailcreditshistory?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&subAccountEmail=mail@example.com&publicAccountID=

LoadSubAccountSettings

`/Account/LoadSubAccountSettings`

Loads settings of subaccount

Parameters

ViewSubAccounts

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
publicAccountID	string	No	null	Public key of sub-account to load settings for. Use subAccountEmail or publicAccountID not both.
subAccountEmail	string	No	null	Email address of Sub-Account

Returns

{"success": true, "data": { SubAccountSettings } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/loadsubaccountsettings?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&subAccountEmail=mail@example.com&publicAccountID=

LoadUsage

`/Account/LoadUsage`

Shows usage of your account in given time.

Parameters

ViewBilling

Access Level

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.
loadSubaccountsUsage	boolean	No	true

Returns

{"success": true, "data": { List of Usage } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/loadusage?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&from=2001-01-01T01:01:01&to=2001-01-01T01:01:01&loadSubaccountsUsage=

LoadWebhook

`/Account/LoadWebhook`

Load notifications webhooks

Parameters

ViewSettings

Access Level

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 number of returned items.
offset	int	No	0	How many items should be returned ahead.

Returns

{"success": true, "data": { List of Webhook } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/loadwebhook?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&limit=100&offset=20

LoadWebNotificationOptions

`/Account/LoadWebNotificationOptions`

Load web notification options of your account

Parameters

ViewSettings

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.

Returns

{"success": true, "data": { WebNotificationOptions } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/loadwebnotificationoptions?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW

Overview

`/Account/Overview`

Shows summary for your account.

Parameters

ViewAccount

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.

Returns

{"success": true, "data": { AccountOverview } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/overview?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW

ProfileOverview

`/Account/ProfileOverview`

Shows you account's profile basic overview

Parameters

ViewAccount

Access Level

Name	Type	Required?	Default value	Description

Returns

{"success": true, "data": { Profile } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/profileoverview?

RemoveSubAccountCredits

`/Account/RemoveSubAccountCredits`

Remove email credits from a sub-account

Parameters

ModifySubAccounts

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
notes	string	Yes		Specific notes about the transaction
credits	int	No	null	Amount of credits to remove
publicAccountID	string	No	null	Public key of sub-account to remove credits from. Use subAccountEmail or publicAccountID not both.
removeAll	boolean	No	false	Remove all credits of this type from sub-account (overrides credits if provided)
subAccountEmail	string	No	null	Email address of Sub-Account

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/removesubaccountcredits?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&notes=&subAccountEmail=mail@example.com&publicAccountID=&credits=&removeAll=

UpdateAdvancedOptions

`/Account/UpdateAdvancedOptions`

Update sending and tracking options of your account.

Parameters

ModifySettings

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
allowCustomHeaders	boolean	No	null	True, if you want to apply custom headers to your emails. Otherwise, false
autoTextFromHtml	boolean	No	null	True, if text BODY of message should be created automatically. Otherwise, false
bccEmail	string	No	null	Email address to send a copy of all email to.
consentTrackingOnUnsubscribe	boolean	No	null
contentTransferEncoding	string	No	null	Type of content encoding
deliveryReason	string	No	null	Why your clients are receiving your emails.
emailNotificationEmail	string	No	null	Specific email address to send bounce email notifications to.
emailNotificationForError	boolean	No	null	True, if you want bounce notifications returned. Otherwise, false
enableClickTracking	boolean	No	null	True, if you want to track clicks. Otherwise, false
enableLinkClickTracking	boolean	No	null	True, if you want to track by link tracking. Otherwise, false
enableOpenTracking	boolean	No	null	True, if you want to track opens. Otherwise, false
enableTemplateScripting	boolean	No	true	True, if you want to use template scripting in your emails {{}}. Otherwise, false
enableUITooltips	boolean	No	null	True, if Account has tooltips active. Otherwise, false
logoUrl	string	No	null	URL to your logo image.
lowCreditNotification	boolean	No	null	True, if you want to receive low credit email notifications. Otherwise, false
manageSubscribedOnly	boolean	No	null	True, if you want to only display labels that the contact is subscribed to on your unsubscribe form. Otherwise, false
manageSubscriptions	boolean	No	null	True, if you want to display your labels on your unsubscribe form. Otherwise, false
notificationsEmails	string	No	null	Email addresses to send a copy of all notifications from our system. Separated by semicolon
skipListUnsubscribe	boolean	No	null	True, if you do not want to use list-unsubscribe headers. Otherwise, false
staleContactInactiveDays	int	No	null	(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
staleContactScore	int	No	null	(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
transactionalOnUnsubscribe	boolean	No	null	True, if you want to display an option for the contact to opt into transactional email only on your unsubscribe form. Otherwise, false
tutorialsEnabled	boolean	No	null	True, if you want to enable Dashboard Tutotials
unsubscribeNotificationsEmails	string	No	null	Emails, separated by semicolon, to which the notification about contact unsubscribing should be sent to

Returns

{"success": true, "data": { AdvancedOptions } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/updateadvancedoptions?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&enableClickTracking=true&enableLinkClickTracking=true&manageSubscriptions=true&manageSubscribedOnly=true&transactionalOnUnsubscribe=true&skipListUnsubscribe=true&autoTextFromHtml=true&allowCustomHeaders=true&bccEmail=your@email.com&contentTransferEncoding=Base64&emailNotificationForError=false&emailNotificationEmail=your@emailaddress.com&lowCreditNotification=true&enableUITooltips=true&notificationsEmails=email1@example.com;email2@example.com&unsubscribeNotificationsEmails=email1@example.com;email2@example.com&logoUrl=http://yourdomain.com/logo.png&enableTemplateScripting=true&staleContactScore=-4&staleContactInactiveDays=180&deliveryReason=Reason&tutorialsEnabled=true&enableOpenTracking=true&consentTrackingOnUnsubscribe=

UpdateCustomBranding

`/Account/UpdateCustomBranding`

Update settings of your private branding. These settings are needed, if you want to use Doali Email under your brand.

Parameters

ModifySettings

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
addLogoToSubAccountsEmails	boolean	No	false
authProviderClientID	string	No	null
authProviderClientSecret	string	No	null
authProviderHideLogin	boolean	No	null
authProviderLogoutUrl	string	No	null
authProviderURL	string	No	null
customBouncesDomain	string	No	null
enablePrivateBranding	boolean	No	false	True: Turn on or off ability to send mails under your brand. Otherwise, false
logoUrl	string	No	null	URL to your logo image.
paymentUrl	string	No	null	URL for making payments.
privateBrandingCustomHeader	string	No	null	private branding custom header content
privateBrandingUrl	string	No	null	Subdomain for your rebranded service
smtpAddress	string	No	null	Address of SMTP server.
smtpAlternative	string	No	null	Address of alternative SMTP server.
supportLink	string	No	null	Address to your support.

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/updatecustombranding?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&enablePrivateBranding=true&logoUrl=http://yourdomain.com/logo.png&supportLink=http://help.yourdomain.com&privateBrandingUrl=mailing.yourdomain.com&smtpAddress=smtp.yourdomain.com&smtpAlternative=smtp2.yourdomain.com&paymentUrl=http://payments.yourdomain.com&customBouncesDomain=&privateBrandingCustomHeader=&authProviderURL=&authProviderClientID=&authProviderClientSecret=&authProviderLogoutUrl=&authProviderHideLogin=&addLogoToSubAccountsEmails=

UpdateInboundNotifications

`/Account/UpdateInboundNotifications`

Update inbound notifications options of your account.

Parameters

ModifyWebNotifications

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
hubCallBackUrl	string	No	""	URL used for tracking action of inbound emails
inboundContactsOnly	boolean	No	null	True, if you want inbound email to only process contacts from your Account. Otherwise, false
inboundDomain	string	No	null	Domain you use as your inbound domain

Returns

{"success": true, "data": { InboundOptions } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/updateinboundnotifications?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&inboundContactsOnly=true&hubCallBackUrl=http://&inboundDomain=yourdomain.com

UpdateProfile

`/Account/UpdateProfile`

Update your profile.

Parameters

ModifyProfile

Access Level

Name	Type	Required?	Default value	Description
address1	string	Yes		First line of address.
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
city	string	Yes		City.
countryID	int	Yes		Numeric ID of country. A file with the list of countries is available here
firstName	string	Yes		First name.
lastName	string	Yes		Last name.
state	string	Yes		State or province.
zip	string	Yes		Zip/postal code.
address2	string	No	null	Second line of address.
company	string	No	null	Company name.
logoUrl	string	No	null	URL to your logo image.
marketingConsent	boolean	No	null	True if you want to receive newsletters from Doali Email. Otherwise, false. Empty to leave the current value.
phone	string	No	null	Phone number
taxCode	string	No	null	Code used for tax purposes.
website	string	No	null	HTTP address of your website.

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/updateprofile?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&firstName=Fred&lastName=Flintstone&address1=12 Granite Road&city=Bedrock&state=CA&zip=00000&countryID=12345&marketingConsent=true/false&address2=Apartment B&company=Slate&website=http://example.com&logoUrl=http://yourdomain.com/logo.png&taxCode=&phone=1234567890

UpdateSubAccountSettings

`/Account/UpdateSubAccountSettings`

Updates settings of specified subaccount

Parameters

ModifySubAccounts

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
allow2fa	boolean	No	null	True, if you want to allow two-factor authentication. Otherwise, false.
dailySendLimit	int	No	null	Amount of emails Account can send daily
emailSizeLimit	int	No	10	Maximum size of email including attachments in MB's
enableContactFeatures	boolean	No	null	True, if you want to use Contact Delivery Tools. Otherwise, false
enablePrivateIPRequest	boolean	No	false	True, if Account can request for private IP on its own. Otherwise, false
maxContacts	int	No	0	Maximum number of contacts the Account can have
monthlyRefillCredits	int	No	0	Amount of credits added to Account automatically
poolName	string	No	null	Name of your custom IP Pool to be used in the sending process
publicAccountID	string	No	null	Public key of sub-account to update. Use subAccountEmail or publicAccountID not both.
requiresEmailCredits	boolean	No	false	True, if Account needs credits to send emails. Otherwise, false
sendingPermission	SendingPermission	No	null	Sending permission setting for Account
subAccountEmail	string	No	null	Email address of Sub-Account
validSenderDomainOnly	boolean	No	null

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/updatesubaccountsettings?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&requiresEmailCredits=true&allow2fa=&monthlyRefillCredits=1000&dailySendLimit=100000&emailSizeLimit=10&enablePrivateIPRequest=true&maxContacts=100000&subAccountEmail=mail@example.com&publicAccountID=&sendingPermission=All&enableContactFeatures=&poolName=My Custom Pool&validSenderDomainOnly=

UpdateValidSenderDomainOnly

`/Account/UpdateValidSenderDomainOnly`

Update Valid Sender Domain Only option

Parameters

ModifyAccount

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
validSenderDomainOnly	boolean	Yes

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/updatevalidsenderdomainonly?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&validSenderDomainOnly=

UpdateWebhook

`/Account/UpdateWebhook`

Update notification webhook

Parameters

ModifyWebNotifications

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
webhookID	string	Yes
isEnabled	boolean	No	true
name	string	No	null	Filename
notificationForAbuseReport	boolean	No	null
notificationForClicked	boolean	No	null
notificationForError	boolean	No	null
notificationForOpened	boolean	No	null
notificationForSent	boolean	No	null
notificationForUnsubscribed	boolean	No	null
notifyOncePerEmail	boolean	No	null
webNotificationUrl	string	No	null	URL address to receive web notifications to parse and process.

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/account/updatewebhook?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&webhookID=&name=attachment.txt&webNotificationUrl=http://&notifyOncePerEmail=&notificationForSent=&notificationForOpened=&notificationForClicked=&notificationForUnsubscribed=&notificationForAbuseReport=&notificationForError=&isEnabled=

Campaign
Manage all aspects of your Campaigns.

Add

`/Campaign/Add`

Adds a Campaign to the queue for processing based on the configuration.

Parameters

ModifyCampaigns

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
campaign	Campaign	Yes		JSON representation of a campaign

Returns

{"success": true, "data": Channel ID } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/campaign/add?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&campaign=

Copy

`/Campaign/Copy`

Makes a copy of a campaign configuration and leaves it in draft mode for further editing.

Parameters

ModifyCampaigns

Access Level

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.
newCampaignName	string	No	null

Returns

{"success": true, "data": Newly created Campaign's ChannelID } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/campaign/copy?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&channelID=123456&newCampaignName=

Delete

`/Campaign/Delete`

Deletes the Campaign. This will not cancel emails that are in progress, see /log/cancelinprogress for this option.

Parameters

ModifyCampaigns

Access Level

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.

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/campaign/delete?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&channelID=123456

Export

`/Campaign/Export`

Export Campaign data to the chosen file format.

Parameters

Export

Access Level

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 including extension.

Returns

{"success": true, "data": { ExportLink } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/campaign/export?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&channelIDs=123,634&fileFormat=Csv&compressionFormat=Zip&fileName=filename.txt

List

`/Campaign/List`

Returns a list all of your Campaigns.

Parameters

ViewCampaigns

Access Level

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 number of returned items.
offset	int	No	0	How many items should be returned ahead.
search	string	No	null	Text fragment used for searching.

Returns

{"success": true, "data": { List of CampaignChannel } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/campaign/list?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&search=text&offset=20&limit=100

TriggerAutomation

`/Campaign/TriggerAutomation`

Manually trigger the given Automation for the provided contact.

Parameters

ModifyAutomations

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
automationName	string	Yes		Name of an active Automation
email	string	Yes		Contact email to trigger this Automation for

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/campaign/triggerautomation?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&email=&automationName=

TriggerAutomationForList

`/Campaign/TriggerAutomationForList`

Manually trigger the given Automation for the provided list.

Parameters

ModifyAutomations

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
automationName	string	Yes		Name of an active Automation
listname	string	Yes		Name of the list to trigger this Automation for

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/campaign/triggerautomationforlist?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&listname=&automationName=

Update

`/Campaign/Update`

Updates a previously added Campaign. Only Active, Paused, and Draft campaigns can be updated.

Parameters

ModifyCampaigns

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
campaign	Campaign	Yes		JSON representation of a campaign

Returns

{"success": true, "data": Channel ID } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/campaign/update?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&campaign=

Channel
Manage SMTP and HTTP API Channels for grouping email delivery.

Add

`/Channel/Add`

Manually add a Channel to your Account to group email.

Parameters

ModifyChannels

Access Level

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.

Returns

{"success": true, "data": Channel Name } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/channel/add?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&name=

Delete

`/Channel/Delete`

Delete the selected Channel.

Parameters

ModifyChannels

Access Level

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.

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/channel/delete?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&name=

Export

`/Channel/Export`

Export selected Channels to chosen file format.

Parameters

Export

Access Level

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
allChannels	boolean	No	false
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 including extension.

Returns

{"success": true, "data": { ExportLink } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/channel/export?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&channelNames=Channel1,Channel2&allChannels=&fileFormat=Csv&compressionFormat=Zip&fileName=filename.txt

List

`/Channel/List`

Returns a list your Channels.

Parameters

ViewChannels

Access Level

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 number of returned items.
offset	int	No	0	How many items should be returned ahead.
search	string	No	null	Text fragment used for searching.

Returns

{"success": true, "data": { List of Channel } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/channel/list?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&limit=100&offset=20&search=text

Update

`/Channel/Update`

Rename an existing Channel.

Parameters

ModifyChannels

Access Level

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.

Returns

{"success": true, "data": Channel Name } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/channel/update?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&name=&newName=

Contact
Methods used to manage your Contacts.

Add

`/Contact/Add`

Add a new contact and optionally to one of your lists. Note that your API KEY is not required for this call.

Parameters

Name	Type	Required?	Default value	Description
email	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	Custom template to use for sending double opt-in activation emails.
alreadyActiveUrl	string	No	null	Url to navigate to if contact already is subscribed
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.
consentTracking	ConsentTracking	No	ApiTypes.ConsentTracking.Unknown	Does the contant consent to have their tracking data stored.
field	Repeated list of string keys and string values	No	null	Custom contact field like companyname, customernumber, city etc. Request parameters prefixed by field_ like field_companyname, field_customernumber, field_city
firstName	string	No	null	First name.
lastName	string	No	null	Last name.
listName	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. Please note that this is different from the listid field.
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 contact. 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.

Returns

Redirection to the user's provided URL or the subscription confirmation OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/contact/add?publicAccountID=EB3EBB7A-C20D-4D39-8F2F-5E6842F58E6F&email=mail@example.com&publicListID=E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F&listName=My List 1&firstName=Fred&lastName=Flintstone&source=&returnUrl=http://yourdomain.com&sourceUrl=http://source.url.com&activationReturnUrl=http://yourwebsite.com/thankyou&activationTemplate=&sendActivation=&consentDate=1/1/2015 0:00:00 AM&consentIP=192.168.0.1&field_firstname=english&notifyEmail=john@test.com&alreadyActiveUrl=&consentTracking=Allow

AddBlocked

`/Contact/AddBlocked`

Manually add or update a contacts status to Abuse or Unsubscribed status (blocked).

Parameters

ModifyContacts

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
email	string	Yes		Proper email address.
status	ContactStatus	Yes		Status of the given resource

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/contact/addblocked?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&email=mail@example.com&status=1

ChangeProperty

`/Contact/ChangeProperty`

Change any property on the contact record.

Parameters

ModifyContacts

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
email	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.

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/contact/changeproperty?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&email=mail@example.com&name=&value=

ChangeStatus

`/Contact/ChangeStatus`

Changes status of selected Contacts. You may provide RULE for selection or specify list of Contact IDs.

Parameters

ModifyContacts

Access Level

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		Status of the given resource
emails	List of string	No	null	Comma delimited list of contact emails
rule	string	No	null	Query used for filtering.

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/contact/changestatus?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&status=1&rule=Status%20=%20Engaged&emails=mail@contact.com,mail1@contact.com,mail2@contact.com

Count

`/Contact/Count`

Counts the number of contacts by rule.

Parameters

ViewContacts

Access Level

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	No	null	Query used for filtering.

Returns

{"success": true, "data": long } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/contact/count?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&rule=Status%20=%20Engaged

CountByStatus

`/Contact/CountByStatus`

Returns number of Contacts, RULE specifies contact Status.

Parameters

ViewContacts

Access Level

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	No	null	Query used for filtering.

Returns

{"success": true, "data": { ContactStatusCounts } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/contact/countbystatus?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&rule=Status%20=%20Engaged

CountByUnsubscribeReason

`/Contact/CountByUnsubscribeReason`

Returns count of unsubscribe reasons for unsubscribed and complaint contacts.

Parameters

ViewContacts

Access Level

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.

Returns

{"success": true, "data": { ContactUnsubscribeReasonCounts } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/contact/countbyunsubscribereason?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&from=2001-01-01T01:01:01&to=2001-01-01T01:01:01

Delete

`/Contact/Delete`

Permanently deletes the contacts provided. You can provide either a qualified rule or a list of emails (comma separated string).

Parameters

ModifyContacts

Access Level

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.

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/contact/delete?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&rule=Status%20=%20Engaged&emails=mail@contact.com,mail1@contact.com,mail2@contact.com

DeleteOne

`/Contact/DeleteOne`

Permanently deletes the provided contact. Should be used to remove contacts with invalid syntax.

Parameters

ModifyContacts

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
email	string	Yes		Proper email address.

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/contact/deleteone?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&email=mail@example.com

Export

`/Contact/Export`

Export selected Contacts to file.

Parameters

Export

Access Level

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 including extension.
rule	string	No	null	Query used for filtering.

Returns

{"success": true, "data": { ExportLink } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/contact/export?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&fileFormat=Csv&rule=Status%20=%20Engaged&emails=mail@contact.com,mail1@contact.com,mail2@contact.com&compressionFormat=Zip&fileName=filename.txt

ExportUnsubscribeReasonCount

`/Contact/ExportUnsubscribeReasonCount`

Export contacts' unsubscribe reasons count to file.

Parameters

Export

Access Level

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 including extension.
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.

Returns

{"success": true, "data": { ExportLink } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/contact/exportunsubscribereasoncount?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&from=2001-01-01T01:01:01&to=2001-01-01T01:01:01&fileFormat=Csv&compressionFormat=Zip&fileName=filename.txt

FindContact

`/Contact/FindContact`

Finds all Lists and Segments this email belongs to.

Parameters

ViewContacts

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
email	string	Yes		Proper email address.

Returns

{"success": true, "data": { ContactCollection } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/contact/findcontact?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&email=mail@example.com

GetContactsByList

`/Contact/GetContactsByList`

List of Contacts for provided List

Parameters

ViewContacts

Access Level

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 number of returned items.
offset	int	No	0	How many items should be returned ahead.

Returns

{"success": true, "data": { List of Contact } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/contact/getcontactsbylist?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&listName=My List 1&limit=100&offset=20

GetContactsBySegment

`/Contact/GetContactsBySegment`

List of Contacts for provided Segment

Parameters

ViewContacts

Access Level

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 number of returned items.
offset	int	No	0	How many items should be returned ahead.

Returns

{"success": true, "data": { List of Contact } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/contact/getcontactsbysegment?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&segmentName=My Segment 1&limit=100&offset=20

List

`/Contact/List`

List of all contacts. If you have not specified RULE, all Contacts will be listed.

Parameters

ViewContacts

Access Level

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 number of returned items.
offset	int	No	0	How many items should be returned ahead.
rule	string	No	null	Query used for filtering.
sort	ContactSort	No	null

Returns

{"success": true, "data": { List of Contact } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/contact/list?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&rule=Status%20=%20Engaged&limit=100&offset=20&sort=

LoadBlocked

`/Contact/LoadBlocked`

Load blocked contacts

Parameters

ViewContacts

Access Level

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 number of returned items.
offset	int	No	0	How many items should be returned ahead.
search	string	No	null	Text fragment used for searching.

Returns

{"success": true, "data": { List of BlockedContact } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/contact/loadblocked?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&statuses=&search=text&limit=100&offset=20

LoadContact

`/Contact/LoadContact`

Load detailed contact information

Parameters

ViewContacts

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
email	string	Yes		Proper email address.

Returns

{"success": true, "data": { Contact } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/contact/loadcontact?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&email=mail@example.com

QuickAdd

`/Contact/QuickAdd`

Add new Contact to one of your Lists.

Parameters

ModifyContacts

Access Level

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.
consentTracking	ConsentTracking	No	ApiTypes.ConsentTracking.Unknown	Does the contant consent to have their tracking data stored.
field	Repeated list of string keys and string values	No	null	Custom contact field like companyname, customernumber, city etc. Request parameters prefixed by field_ like field_companyname, field_customernumber, field_city
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. Please note that this is different from the listid field.
source	ContactSource	No	ApiTypes.ContactSource.ManualInput	Specifies the way of uploading the contact
status	ContactStatus	No	ApiTypes.ContactStatus.Active	Status of the given resource

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/contact/quickadd?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&emails=mail@contact.com,mail1@contact.com,mail2@contact.com&firstName=Fred&lastName=Flintstone&publicListID=E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F&listName=My List 1&status=1&notes=Contact is extremely important!&consentDate=1/1/2015 0:00:00 AM&consentIP=192.168.0.1&field_firstname=english&notifyEmail=john@test.com&consentTracking=Allow&source=

`/Contact/Subscribe`

Basic double opt-in email subscribe form for your account. This can be used for contacts that need to re-subscribe as well.

Parameters

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.

Returns

Redirection to the Subscription Confirmation Form OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/contact/subscribe?publicAccountID=EB3EBB7A-C20D-4D39-8F2F-5E6842F58E6F

Update

`/Contact/Update`

Update selected contact. Omitted contact's fields will be reset by default (see the clearRestOfFields parameter)

Parameters

ModifyContacts

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
email	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 companyname, customernumber, city etc. JSON serialized text like { "city":"london" }
field	Repeated list of string keys and string values	No	null	Custom contact field like companyname, customernumber, city etc. Request parameters prefixed by field_ like field_companyname, field_customernumber, field_city
firstName	string	No	null	First name.
lastName	string	No	null	Last name.

Returns

{"success": true, "data": { Contact } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/contact/update?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&email=mail@example.com&firstName=Fred&lastName=Flintstone&clearRestOfFields=false&field_firstname=english&customFields=english

Upload

`/Contact/Upload`

Upload contacts in CSV file.

Parameters

ModifyContacts

Access Level

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.
consentTracking	ConsentTracking	No	ApiTypes.ConsentTracking.Unknown	Does the contant consent to have their tracking data stored.
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	Status of the given resource
Attach the file as POST multipart/form-data file upload or PUT file upload with content-disposition header

Returns

{"success": true, "data": Number of contacts uploaded successfully } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/contact/upload?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&allowUnsubscribe=&listID=1234&listName=&status=1&consentDate=1/1/2015 0:00:00 AM&consentIP=192.168.0.1&consentTracking=Allow

Domain
Manage sending domains and verify DNS configurations.

Add

`/Domain/Add`

Add a new domain to be registered and secured to an Account.

Parameters

ModifySettings

Access Level

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.
setAsDefault	boolean	No	false	Set this domain as the default domain for the Account.

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/domain/add?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&domain=example.com&setAsDefault=

Delete

`/Domain/Delete`

Deletes a domain from the Account.

Parameters

ModifySettings

Access Level

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.

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/domain/delete?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&domain=example.com

List

`/Domain/List`

Lists all the domains configured for this Account.

Parameters

ViewSettings

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.

Returns

{"success": true, "data": { List of DomainDetail } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/domain/list?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW

SetDefault

`/Domain/SetDefault`

Sets the default sender for the Account as an email address from a verified domain.

Parameters

ModifySettings

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
email	string	Yes		Email address of a verified domain to be used as default when sending from non-verified domains.

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/domain/setdefault?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&email=

SetVerp

`/Domain/SetVerp`

Allow to use VERP on given domain and specify custom bounces domain.

Parameters

ModifySettings

Access Level

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.
isVerp	boolean	Yes
customBouncesDomain	string	No	null
isCustomBouncesDomainDefault	boolean	No	false

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/domain/setverp?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&domain=example.com&isVerp=&customBouncesDomain=&isCustomBouncesDomainDefault=

VerifyDkim

`/Domain/VerifyDkim`

Verifies proper DKIM DNS configuration for the domain.

Parameters

ModifySettings

Access Level

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		Domain name to verify.

Returns

{"success": true, "data": string } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/domain/verifydkim?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&domain=

VerifyDMARC

`/Domain/VerifyDMARC`

Verifies proper DMARC DNS configuration for the domain.

Parameters

ModifySettings

Access Level

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		Domain name to verify.

Returns

{"success": true, "data": string } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/domain/verifydmarc?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&domain=

VerifyMX

`/Domain/VerifyMX`

Verifies proper MX DNS configuration for the domain.

Parameters

ModifySettings

Access Level

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		Domain name to verify.

Returns

{"success": true, "data": string } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/domain/verifymx?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&domain=

VerifySpf

`/Domain/VerifySpf`

Verifies proper SPF DNS configuration for the domain.

Parameters

ModifySettings

Access Level

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		Domain name to verifiy.

Returns

{"success": true, "data": { ValidationStatus } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/domain/verifyspf?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&domain=

VerifyTracking

`/Domain/VerifyTracking`

Verifies proper CNAME DNS configuration for the tracking domain.

Parameters

ModifySettings

Access Level

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		Domain name to verify.
trackingType	TrackingType	No	ApiTypes.TrackingType.Http

Returns

{"success": true, "data": string } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/domain/verifytracking?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&domain=&trackingType=

Email
Send your emails and see their statuses

GetStatus

`/Email/GetStatus`

Get email batch status

Parameters

ViewReports

Access Level

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.

Returns

{"success": true, "data": { EmailJobStatus } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/email/getstatus?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&transactionID=&showFailed=&showSent=&showDelivered=&showPending=&showOpened=&showClicked=&showAbuse=&showUnsubscribed=&showErrors=&showMessageIDs=

ListAttachments

`/Email/ListAttachments`

Lists the file attachments for the specified email.

Parameters

ViewFiles

Access Level

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.

Returns

{"success": true, "data": { List of File } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/email/listattachments?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&msgID=ABCDE_9RPhSWiaJq_ab1g1

Send

`/Email/Send`

Submit emails. The HTTP POST request is suggested. The default, maximum (accepted by us) size of an email is 10 MB in total, with or without attachments. For suggested implementations please refer to https://api.doali.com/support/http-api/. Emails are stored for 7 or 35 days, depending on you pricing plan.

Parameters

SendHttp

Access Level

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 (via the File/Upload request) that should be sent with this e-mail.
bodyAmp	string	No	null	AMP email body
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…
charsetBodyAmp	string	No	null	Sets charset for body AMP MIME part (overrides default value from charset parameter)
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	Name or ID of the previously uploaded file (via the File/Upload request) which should be a CSV list of Recipients.
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.
trackClicks	boolean	No	null	Should the clicks be tracked? If no value has been provided, Account's default setting will be used.
trackOpens	boolean	No	null	Should the opens be tracked? If no value has been provided, Account's default setting will be used.
utmCampaign	string	No	null	The utm_campaign marketing parameter appended to each link in the campaign.
utmContent	string	No	null	The utm_content marketing parameter appended to each link in the campaign.
utmMedium	string	No	null	The utm_medium marketing parameter appended to each link in the campaign.
utmSource	string	No	null	The utm_source marketing parameter appended to each link in the campaign.
Attach the file as POST multipart/form-data file upload

Returns

{"success": true, "data": { EmailSend } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/email/send?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&subject=&from=&fromName=&sender=&senderName=&msgFrom=&msgFromName=&replyTo=&replyToName=&to=&msgTo=&msgCC=&msgBcc=&lists=&segments=&mergeSourceFilename=&dataSource=&channel=&bodyHtml=&bodyText=&charset=&charsetBodyHtml=&charsetBodyText=&encodingType=&template=&headers_firstname=firstname: myValueHere&postBack=&merge_firstname=John&timeOffSetMinutes=&poolName=My Custom Pool&isTransactional=false&attachments=&trackOpens=true&trackClicks=true&utmSource=source1&utmMedium=medium1&utmCampaign=campaign1&utmContent=content1&bodyAmp=&charsetBodyAmp=

Status

`/Email/Status`

Detailed status of a unique email sent through your account. Returns a 'Email has expired and the status is unknown.' error, if the email has not been fully processed yet.

Parameters

ViewReports

Access Level

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.

Returns

{"success": true, "data": { EmailStatus } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/email/status?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&messageID=-HHGPM_9RPhSMiaJq_ab4g3

VerificationResult

`/Email/VerificationResult`

Checks if verification emails is completed.

Parameters

VerifyEmails

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
txID	GUID	Yes

Returns

{"success": true, "data": { Export } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/email/verificationresult?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&txID=

Verify

`/Email/Verify`

Verify single email address

Parameters

VerifyEmails

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
email	string	Yes		Proper email address.
updateStatus	boolean	No	false	Should the existing contact's status be changed automatically based on the validation result
uploadContact	boolean	No	false

Returns

{"success": true, "data": { EmailValidationResult } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/email/verify?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&email=mail@example.com&uploadContact=&updateStatus=

VerifyList

`/Email/VerifyList`

Verify list of email addresses. Each email in the file (if used) has to be in a new line. This is asynchronous task. To check if task is completed use VerificationResult with returned task ID.

Parameters

VerifyEmails

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
listOfEmails	List of string	No	null
rule	string	No	null	Query used for filtering.
updateStatus	boolean	No	false	Should the existing contacts' status be changed automatically based on the validation results
uploadContacts	boolean	No	false
Attach the file as POST multipart/form-data file upload or PUT file upload with content-disposition header

Returns

{"success": true, "data": string } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/email/verifylist?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&rule=Status%20=%20Engaged&listOfEmails=&uploadContacts=&updateStatus=

View

`/Email/View`

View email. Email previews are stored for 7 or 35 days, depending on you pricing plan.

Parameters

Name	Type	Required?	Default value	Description
messageID	string	Yes		Message identifier
enableTracking	boolean	No	false

Returns

{"success": true, "data": { EmailView } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/email/view?messageID=&enableTracking=

Export
Manage all of the exported data from the system.

CheckStatus

`/Export/CheckStatus`

Check the current status of the export.

Parameters

Export

Access Level

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		ID of the exported file

Returns

{"success": true, "data": { ExportStatus } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/export/checkstatus?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&publicExportID=E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F

Delete

`/Export/Delete`

Delete the specified export.

Parameters

Export

Access Level

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		ID of the exported file

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/export/delete?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&publicExportID=E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F

DownloadBulk

`/Export/DownloadBulk`

Download the specified export files in one package

Parameters

Export

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
publicExportIDs	List of GUID	Yes

Returns

Output stream containing file data OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/export/downloadbulk?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&publicExportIDs=

List

`/Export/List`

Returns a list of all exported data.

Parameters

Export

Access Level

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 number of returned items.
offset	int	No	0	How many items should be returned ahead.

Returns

{"success": true, "data": { List of Export } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/export/list?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&limit=100&offset=20

File
Manage the files on your account

Delete

`/File/Delete`

Permanently deletes the file from your Account.

Parameters

ModifyFiles

Access Level

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	Unique identifier for the file stored in your Account.
filename	string	No	null	Name of your file including extension.

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/file/delete?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&fileID=123456&filename=filename.txt

Download

`/File/Download`

Downloads the file to your local device.

Parameters

ViewFiles

Access Level

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	Unique identifier for the file stored in your Account.
filename	string	No	null	Name of your file including extension.

Returns

Output stream containing file data OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/file/download?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&filename=filename.txt&fileID=123456

ListAll

`/File/ListAll`

Lists your available files.

Parameters

ViewFiles

Access Level

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 number of returned items.
offset	int	No	0	How many items should be returned ahead.

Returns

{"success": true, "data": { List of File } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/file/listall?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&limit=100&offset=20

Load

`/File/Load`

Returns detailed file information for the given file.

Parameters

ViewFiles

Access Level

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 including extension.

Returns

{"success": true, "data": { File } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/file/load?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&filename=filename.txt

Upload

`/File/Upload`

Uploads selected file to your Account using http form upload format (MIME multipart/form-data) or PUT method.

Parameters

ModifyFiles

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
enforceUniqueFileName	boolean	No	false	If a file exists with the same name do not upload and override the file.
expiresAfterDays	int	No	35	Number of days the file should be stored for.
name	string	No	null	Filename
Attach the file as POST multipart/form-data file upload or PUT file upload with content-disposition header

Returns

{"success": true, "data": { File } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/file/upload?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&name=attachment.txt&expiresAfterDays=&enforceUniqueFileName=

List
API methods for managing your Lists

Add

`/List/Add`

Create new list, based on filtering rule or list of IDs

Parameters

ModifyContacts

Access Level

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.

Returns

{"success": true, "data": List ID } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/list/add?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&listName=My List 1&createEmptyList=&allowUnsubscribe=true/false&rule=Status%20=%20Engaged&emails=mail@contact.com,mail1@contact.com,mail2@contact.com&allContacts=true/false

AddContacts

`/List/AddContacts`

Add existing Contacts to chosen list

Parameters

ModifyContacts

Access Level

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
emails	List of string	No	null	Comma delimited list of contact emails
listId	int	No	null	ID number of selected list.
listName	string	No	null	Name of your list.
rule	string	No	null	Query used for filtering.

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/list/addcontacts?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&listName=My List 1&listId=1234&rule=Status%20=%20Engaged&emails=mail@contact.com,mail1@contact.com,mail2@contact.com&allContacts=true/false

Copy

`/List/Copy`

Copy your existing List with the option to provide new settings to it. Some fields, when left empty, default to the source list's settings

Parameters

ModifyContacts

Access Level

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	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	The name of the list you want to copy
rule	string	No	null	Query used for filtering.
sourceListId	int	No	null
sourceListName	string	No	null

Returns

{"success": true, "data": New list's ID } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/list/copy?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&newlistName=&createEmptyList=true/false&allowUnsubscribe=true/false&rule=Status%20=%20Engaged&sourceListName=&sourceListId=

CreateFromCampaign

`/List/CreateFromCampaign`

Create a new list from the recipients of the given campaign, using the given statuses of Messages

Parameters

ModifyContacts

Access Level

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
listId	int	No	null	ID number of selected list.
listName	string	No	null	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)

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/list/createfromcampaign?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&campaignID=&listName=My List 1&listId=1234&statuses=

CreateNthSelectionLists

`/List/CreateNthSelectionLists`

Create a series of nth selection lists from an existing list or segment

Parameters

ModifyContacts

Access Level

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.

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/list/createnthselectionlists?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&listName=My List 1&numberOfLists=3&excludeBlocked=true/false&allowUnsubscribe=true/false&rule=Status%20=%20Engaged&allContacts=true/false

CreateRandomList

`/List/CreateRandomList`

Create a new list with randomized contacts from an existing list or segment

Parameters

ModifyContacts

Access Level

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.

Returns

{"success": true, "data": List ID } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/list/createrandomlist?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&listName=My List 1&count=100&excludeBlocked=true/false&allowUnsubscribe=true/false&rule=Status%20=%20Engaged&allContacts=true/false

Delete

`/List/Delete`

Deletes List and removes all the Contacts from it (does not delete Contacts).

Parameters

ModifyContacts

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
listId	int	No	null	ID number of selected list.
listName	string	No	null	Name of your list.

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/list/delete?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&listName=My List 1&listId=1234

Export

`/List/Export`

Exports all the contacts from the provided list

Parameters

Export

Access Level

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 including extension.
listId	int	No	null	ID number of selected list.
listName	string	No	null	Name of your list.

Returns

{"success": true, "data": { ExportLink } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/list/export?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&listName=My List 1&listId=1234&fileFormat=Csv&compressionFormat=Zip&fileName=filename.txt

GetAddContactsStatus

`/List/GetAddContactsStatus`

Adding contacts to the list can take a longer time. You can check current status with this method.

Parameters

ModifyContacts

Access Level

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		list name to check

Returns

{"success": true, "data": will return Ready or InProgress status } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/list/getaddcontactsstatus?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&listName=

list

`/List/list`

Shows all your existing lists

Parameters

ViewContacts

Access Level

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.

Returns

{"success": true, "data": { List of List } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/list/list?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&from=2001-01-01T01:01:01&to=2001-01-01T01:01:01

Load

`/List/Load`

Returns detailed information about specific list.

Parameters

ViewContacts

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
listId	int	No	null	ID number of selected list.
listName	string	No	null	Name of your list.

Returns

{"success": true, "data": { List } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/list/load?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&listName=My List 1&listId=1234

MoveContacts

`/List/MoveContacts`

Move selected contacts from one List to another

Parameters

ModifyContacts

Access Level

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

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/list/movecontacts?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&oldListName=&newListName=&emails=mail@contact.com,mail1@contact.com,mail2@contact.com&moveAll=&statuses=&rule=Status%20=%20Engaged

RemoveContacts

`/List/RemoveContacts`

Remove selected Contacts from your list

Parameters

ModifyContacts

Access Level

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
listId	int	No	null	ID number of selected list.
listName	string	No	null	Name of your list.
rule	string	No	null	Query used for filtering.

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/list/removecontacts?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&listName=My List 1&listId=1234&rule=Status%20=%20Engaged&emails=mail@contact.com,mail1@contact.com,mail2@contact.com

Update

`/List/Update`

Update existing list

Parameters

ModifyContacts

Access Level

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 list. Otherwise, false
listId	int	No	null	ID number of selected list.
listName	string	No	null	Name of your list.
newListName	string	No	null	Name of your list if you want to change it.
trackHistory	boolean	No	false

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/list/update?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&listName=My List 1&listId=1234&newListName=My List 2&allowUnsubscribe=true/false&trackHistory=

Log
Methods to check logs of your campaigns

CancelInProgress

`/Log/CancelInProgress`

Cancels emails that are waiting to be sent.

Parameters

Security

Access Level

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

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/log/cancelinprogress?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&channelName=Channel01&transactionID=TransactionID

Events

`/Log/Events`

Returns log of delivery events filtered by specified parameters.

Parameters

ViewReports

Access Level

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 number of returned items.
offset	int	No	0	How many items should be returned ahead.
statuses	List of LogEventStatus	No	null	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
to	datetime	No	null	Ending date for search in YYYY-MM-DDThh:mm:ss format.

Returns

{"success": true, "data": { EventLog } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/log/events?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&statuses=0&from=2001-01-01T01:01:01&to=2001-01-01T01:01:01&channelName=Channel01&limit=100&offset=20

Export

`/Log/Export`

Export email log information to the specified file format.

Parameters

Export

Access Level

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.
email	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 including extension.
from	datetime	No	null	Start date. If not set then data from last 24h will be returned.
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. If not set then current date is used. Cannot be earlier than "from" date.

Returns

{"success": true, "data": { ExportLink } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/log/export?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&statuses=0&fileFormat=Csv&from=&to=&channelName=Channel01&includeEmail=true/false&includeSms=true/false&messageCategory=1&compressionFormat=Zip&fileName=filename.txt&email=mail@example.com

ExportEvents

`/Log/ExportEvents`

Export delivery events log information to the specified file format.

Parameters

Export

Access Level

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.
compressionFormat	CompressionFormat	No	ApiTypes.CompressionFormat.None	FileResponse compression format. None or Zip.
email	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 including extension.
from	datetime	No	null	Starting date for search in YYYY-MM-DDThh:mm:ss format.
statuses	List of LogEventStatus	No	null	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
to	datetime	No	null	Ending date for search in YYYY-MM-DDThh:mm:ss format.

Returns

{"success": true, "data": { ExportLink } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/log/exportevents?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&statuses=0&from=2001-01-01T01:01:01&to=2001-01-01T01:01:01&channelName=Channel01&fileFormat=Csv&compressionFormat=Zip&fileName=filename.txt&email=mail@example.com

ExportLinkTracking

`/Log/ExportLinkTracking`

Export detailed link tracking information to the specified file format.

Parameters

Export

Access Level

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 including extension.
limit	int	No	0	Maximum number of returned items.
linkSearch	string	No	null
offset	int	No	0	How many items should be returned ahead.

Returns

{"success": true, "data": { ExportLink } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/log/exportlinktracking?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&from=2001-01-01T01:01:01&to=2001-01-01T01:01:01&channelName=Channel01&fileFormat=Csv&limit=100&offset=20&compressionFormat=Zip&fileName=filename.txt&linkSearch=

LinkTracking

`/Log/LinkTracking`

Track link clicks

Parameters

ViewReports

Access Level

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 number of returned items.
linkSearch	string	No	null
offset	int	No	0	How many items should be returned ahead.
to	datetime	No	null	Ending date for search in YYYY-MM-DDThh:mm:ss format.

Returns

{"success": true, "data": { LinkTrackingDetails } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/log/linktracking?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&from=2001-01-01T01:01:01&to=2001-01-01T01:01:01&limit=100&offset=20&channelName=Channel01&linkSearch=

Load

`/Log/Load`

Returns logs filtered by specified parameters. Email logs are stored for 3, 7 or 35 days, depending on you pricing plan.

Parameters

ViewReports

Access Level

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.
email	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.
ipaddress	string	No	null	Search for recipients that we sent through this IP address
limit	int	No	0	Maximum number of returned items.
messageCategory	List of MessageCategory	No	null	ID of message category
offset	int	No	0	How many items should be returned ahead.
to	datetime	No	null	Ending date for search in YYYY-MM-DDThh:mm:ss format.

Returns

{"success": true, "data": { Log } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/log/load?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&statuses=0&from=2001-01-01T01:01:01&to=2001-01-01T01:01:01&channelName=Channel01&limit=100&offset=20&includeEmail=true/false&includeSms=true/false&messageCategory=1&email=mail@example.com&ipaddress=

LoadNotifications

`/Log/LoadNotifications`

Returns notification logs filtered by specified parameters.

Parameters

ViewReports

Access Level

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 number of returned 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 returned ahead.
to	datetime	No	null	Ending date for search in YYYY-MM-DDThh:mm:ss format.
toEmail	string	No	null
useStatusChangeDate	boolean	No	false	True, if 'from' and 'to' parameters should resolve to the Status Change date. To resolve to the creation date - false

Returns

{"success": true, "data": { Log } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/log/loadnotifications?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&statuses=0&from=2001-01-01T01:01:01&to=2001-01-01T01:01:01&limit=100&offset=20&messageCategory=1&useStatusChangeDate=false&notificationType=&toEmail=

Summary

`/Log/Summary`

Loads summary information about activity in chosen date range.

Parameters

ViewReports

Access Level

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

Returns

{"success": true, "data": { LogSummary } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/log/summary?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&from=2001-01-01T01:01:01&to=2001-01-01T01:01:01&channelName=Channel01&interval=daily&transactionID=TransactionID

Segment
Manages your segments - dynamically created lists of contacts

Add

`/Segment/Add`

Create new segment, based on specified RULE.

Parameters

ModifyContacts

Access Level

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.

Returns

{"success": true, "data": { Segment } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/segment/add?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&segmentName=My Segment 1&rule=Status%20=%20Engaged

Copy

`/Segment/Copy`

Copy your existing Segment with the optional new rule and custom name

Parameters

ModifyContacts

Access Level

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.

Returns

{"success": true, "data": { Segment } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/segment/copy?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&sourceSegmentName=&newSegmentName=My Segment 2&rule=Status%20=%20Engaged

Delete

`/Segment/Delete`

Delete existing segment.

Parameters

ModifyContacts

Access Level

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.

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/segment/delete?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&segmentName=My Segment 1

Export

`/Segment/Export`

Exports all the contacts from the provided segment

Parameters

Export

Access Level

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 including extension.

Returns

{"success": true, "data": { ExportLink } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/segment/export?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&segmentName=My Segment 1&fileFormat=Csv&compressionFormat=Zip&fileName=filename.txt

List

`/Segment/List`

Lists all your available Segments

Parameters

ViewContacts

Access Level

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.

Returns

{"success": true, "data": { List of Segment } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/segment/list?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&includeHistory=true/false&from=&to=

LoadByName

`/Segment/LoadByName`

Lists your available Segments using the provided names

Parameters

ViewContacts

Access Level

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.

Returns

{"success": true, "data": { List of Segment } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/segment/loadbyname?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&segmentNames=&includeHistory=true/false&from=&to=

LoadTrackedHistory

`/Segment/LoadTrackedHistory`

Lists your available Segments with tracked history option on

Parameters

ViewContacts

Access Level

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.
includeHistory	boolean	No	false	True: Include history of last 30 days. Otherwise, false.
to	datetime	No	null	Ending date for search in YYYY-MM-DDThh:mm:ss format.

Returns

{"success": true, "data": { List of Segment } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/segment/loadtrackedhistory?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&includeHistory=true/false&from=2001-01-01T01:01:01&to=2001-01-01T01:01:01

Update

`/Segment/Update`

Rename or change RULE for your segment

Parameters

ModifyContacts

Access Level

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.
trackHistory	boolean	No	false

Returns

{"success": true, "data": { Segment } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/segment/update?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&segmentName=My Segment 1&newSegmentName=My Segment 2&rule=Status%20=%20Engaged&trackHistory=

SMS
Send SMS text messages to your clients.

Send

`/SMS/Send`

Send a short SMS Message (maximum of 1600 characters) to any mobile phone.

Parameters

SendSMS

Access Level

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

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/sms/send?apikey=your-apikey&to=%2b100000000&body=text_body_of_your_message

Template
Managing and editing templates of your emails

Add

`/Template/Add`

Create new Template. Needs to be sent using POST method

Parameters

ModifyTemplates

Access Level

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.
bodyAmp	string	No	null	AMP code of email (needs escaping).
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.
tags	List of string	No	null
templateScope	TemplateScope	No	ApiTypes.TemplateScope.Private	Enum: 0 - private, 1 - public

Returns

{"success": true, "data": Template ID } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/template/add?version=2

AddTag

`/Template/AddTag`

Create a new Tag to be used in your Templates

Parameters

ModifyTemplates

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
tag	string	Yes		Tag's value
type	TagType	No	ApiTypes.TagType.Template	Type of tag

Returns

{"success": true, "data": { TemplateTag } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/template/addtag?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&tag=&type=

Copy

`/Template/Copy`

Copy Selected Template

Parameters

ModifyTemplates

Access Level

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.

Returns

{"success": true, "data": { Template } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/template/copy?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&templateID=1234&name=attachment.txt&subject=Hello!&fromEmail=sender@yourdomain.com&fromName=Sender

Delete

`/Template/Delete`

Delete template with the specified ID

Parameters

ModifyTemplates

Access Level

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.

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/template/delete?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&templateID=1234

DeleteBulk

`/Template/DeleteBulk`

Delete templates with the specified ID

Parameters

ModifyTemplates

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
templateIDs	List of int	Yes

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/template/deletebulk?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&templateIDs=

DeleteTag

`/Template/DeleteTag`

Delete a tag, removing it from all Templates

Parameters

ModifyTemplates

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
tag	string	Yes
type	TagType	No	ApiTypes.TagType.Template

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/template/deletetag?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&tag=&type=

GetList

`/Template/GetList`

Lists your templates, optionally searching by Tags

Parameters

ViewTemplates

Access Level

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 number of returned items.
offset	int	No	0	If provided, returns templates with these tags
search	string	No	null	Find templates containing given search string in their names
tags	List of string	No	null
templateOrder	TemplateOrder	No	ApiTypes.TemplateOrder.DateAddedDescending	Filters on template type
templateTypes	List of TemplateType	No	null

Returns

{"success": true, "data": { TemplateList } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/template/getlist?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&tags=&templateTypes=&limit=100&offset=&templateOrder=&search=

GetTagList

`/Template/GetTagList`

Retrieve a list of your Tags

Parameters

ViewTemplates

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
showOnlyInUse	boolean	No	false
type	TagType	No	ApiTypes.TagType.Template

Returns

{"success": true, "data": { TemplateTagList } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/template/gettaglist?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&type=&showOnlyInUse=

IsUsedByCampaign

`/Template/IsUsedByCampaign`

Check if template is used by campaign.

Parameters

ViewTemplates

Access Level

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.

Returns

{"success": true, "data": Is the template used by campaign (true/false) } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/template/isusedbycampaign?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&templateID=1234

LoadTemplate

`/Template/LoadTemplate`

Load template with content

Parameters

ViewTemplates

Access Level

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	No	""	template name (optional - id/name)
templateID	int	No	0	ID number of template.

Returns

{"success": true, "data": { Template } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/template/loadtemplate?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&templateID=1234&name=

ReadRssFeed

`/Template/ReadRssFeed`

Read Rss feed

Parameters

ViewTemplates

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
url	string	Yes		Rss feed url.
count	int	No	3	Number of item tags to read.

Returns

{"success": true, "data": string } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/template/readrssfeed?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&url=&count=

Update

`/Template/Update`

Update existing template, overwriting existing data. Needs to be sent using POST method.

Parameters

ModifyTemplates

Access Level

Name	Type	Required?	Default value	Description

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/template/update?version=2

UpdateDefaultOptions

`/Template/UpdateDefaultOptions`

Bulk change default options and the scope of your templates

Parameters

ModifyTemplates

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
templateIDs	List of int	Yes
fromEmail	string	No	null	Default From: email address.
fromName	string	No	null	Default From: name.
subject	string	No	null	Default subject of email.
templateScope	TemplateScope	No	ApiTypes.TemplateScope.Private	Enum: 0 - private, 1 - public

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/template/updatedefaultoptions?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&templateIDs=&subject=Hello!&fromEmail=sender@yourdomain.com&fromName=Sender&templateScope=1

ValidEmail
Managing sender emails.

Add

`/ValidEmail/Add`

Add new email to account

Parameters

ModifySettings

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
emailAddress	string	Yes
returnUrl	string	No	null	URL to navigate to after Account creation

Returns

{"success": true, "data": { ValidEmail } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/validemail/add?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&emailAddress=&returnUrl=http://yourdomain.com

List

`/ValidEmail/List`

Get list of all valid emails of account.

Parameters

ViewSettings

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.

Returns

{"success": true, "data": { List of ValidEmail } } OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/validemail/list?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW

Remove

`/ValidEmail/Remove`

Delete valid email from account.

Parameters

ModifySettings

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
validEmailID	int	Yes

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/validemail/remove?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&validEmailID=

ResendEmailVerification

`/ValidEmail/ResendEmailVerification`

Resends email verification.

Parameters

ModifySettings

Access Level

Name	Type	Required?	Default value	Description
apikey	string	Yes		ApiKey that gives you access to our SMTP and HTTP API's. Available here.
emailAddress	string	Yes
returnUrl	string	No	null	URL to navigate to after Account creation

Returns

{"success": true} OR {"success": false, "error": string with error message}

Example ^{copy link}

https://api.doali.com/v2/validemail/resendemailverification?apikey=7H29A61A88F5D6F1CX5CC79IWQADW3EFC98CD5F4428W7WU2B873256BCECCDCIAP8A5C4JS6A29675XHFBED2DFCDF9I1QW&emailAddress=&returnUrl=http://yourdomain.com

Classes
Classes used in Doali Email API

AccessLevel Enumeration

Name	Value	Description
None	0
ViewAccount	1
ViewContacts	2
ViewForms	4
ViewTemplates	8
ViewCampaigns	16
ViewChannels	32
ViewAutomations	64
ViewSurveys	128
ViewSettings	256
ViewBilling	512
ViewSubAccounts	1024
ViewUsers	2048
ViewFiles	4096
ViewReports	8192
ModifyAccount	16384
ModifyContacts	32768
ModifyForms	65536
ModifyTemplates	131072
ModifyCampaigns	262144
ModifyChannels	524288
ModifyAutomations	1048576
ModifySurveys	2097152
ModifyFiles	4194304
Export	8388608
SendSmtp	16777216
SendSMS	33554432
ModifySettings	67108864
ModifyBilling	134217728
ModifyProfile	268435456
ModifySubAccounts	536870912
ModifyUsers	1073741824
Security	2147483648
ModifyLanguage	4294967296
ViewSupport	8589934592
SendHttp	17179869184
Modify2FAEmail	34359738368
ModifySupport	68719476736
ViewCustomFields	137438953472
ModifyCustomFields	274877906944
ModifyWebNotifications	549755813888
ExtendedLogs	1099511627776
VerifyEmails	2199023255552
Modify2FASms	4398046511104
ModifyLandingPages	70368744177664
ViewLandingPages	140737488355328
ModifySuppressions	281474976710656
ViewSuppressions	562949953421312
ViewDragDropEditor	1125899906842624
ViewTemplateEditor	2251799813685248
ViewAITools	4503599627370496
ModifySubscriptionAntiSpam	9007199254740992
ViewLandingPagesCheckout	18014398509481984
ModifyLandingPagesCheckout	36028797018963968

AccessToken

Property	Type	Description	Example
AccessLevel	AccessLevel	Access level or permission to be assigned to this Access Token.
AllowUpdate	boolean
DateCreated	datetime	Date this AccessToken was created.
Expires	datetime	Date this AccessToken expires.
LastUse	datetime	Date this AccessToken was last used.
MaskedToken	string
Name	string	Name or email address of the token.
RestrictAccessToIPRange	string	Comma separated list of CIDR notated IP ranges that this token can connect from.	1.1.1.1/32,2.2.2.2/24
Type	AccessTokenType

AccessTokenType Enumeration

Name	Value	Description
APIKey	1	ApiKey that gives you access to our SMTP and HTTP API's.
SMTPCredential	2

Account

Detailed information about your account

Property	Type	Description	Example
AccountPaymentUrl	string	URL for making payments.	http://payments.yourdomain.com
AddLogoToSubAccountsEmails	boolean
Address1	string	First line of address.	12 Granite Road
Address2	string	Second line of address.	Apartment B
AffiliateLink	string	URL for affiliating.	http://
AutoCreditAmount	decimal	When AutoCreditStatus is Enabled, the amount of credit to be recharged.	500
AutoCreditLevel	decimal	When AutoCreditStatus is Enabled, the credit level that triggers the credit to be recharged.	100
AutoCreditStatus	string	Status of automatic payments configuration.	Off
City	string	City.	Bedrock
Company	string	Company name.	Slate
ContentTransferEncoding	string	Type of content encoding	Base64
CountryID	int	Numeric ID of country. A file with the list of countries is available here	12345
Credit	decimal	Current credit in Account for Pay as you go plans.	1000
DailySendLimit	int	Amount of emails Account can send daily	100000
DateCreated	datetime	Creation date.	2001-01-01T12:00:00
DeliveryReason	string	Why your clients are receiving your emails.	Reason
DisableGlobalContacts	boolean
Email	string	Proper email address.	mail@example.com
EmailCredits	int	Amount of email credits	1000
EnableContactFeatures	boolean	Enable contact delivery and optimization tools on your Account.
EnablePrivateBranding	boolean	True: Turn on or off ability to send mails under your brand. Otherwise, false	true
EnablePrivateBrandingCustomHeader	boolean
FirstName	string	First name.	Fred
IsEELogoRequired	boolean	Indicates if EE logo in the footer is required (ex. for trial account on older plan)
IsGoogleAccount	boolean
IsSub	boolean	True, if Account is a Sub-Account. Otherwise, false	false
IsTrusted	boolean
IsUser	boolean
LastName	string	Last name.	Flintstone
LinkTracking	boolean	True, if you have enabled link tracking. Otherwise, false	true
LogoUrl	string	URL to your logo image.	http://yourdomain.com/logo.png
MonthlyEmailsSent	long	Amount of emails sent from this Account	1000
NeedsSMSVerification	boolean
PaymentFormUrl	string	URL form for payments.	http://
Phone	string	Phone number	1234567890
PricePerEmail	decimal	Amount of emails sent from this Account	1000
PrivateBrandingCustomHeader	string
PrivateBrandingUrl	string	Subdomain for your rebranded service	mailing.yourdomain.com
PublicAccountID	string	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
Reputation	double	Numeric reputation	100
Smtp	string	Address of SMTP server.	smtp.yourdomain.com
SmtpAlternative	string	Address of alternative SMTP server.	smtp2.yourdomain.com
State	string	State or province.	CA
StatusFormatted	string	Account status: Active	Active
StatusNumber	int	Number of status: 1 - Active	1
SubAccountsCount	long	The number of Sub-Accounts this Account has.	1
SupportLink	string	Address to your support.	http://help.yourdomain.com
TaxCode	string	Code used for tax purposes.
TotalEmailsSent	long	Amount of emails sent from this Account	1000
UntrustedDeviceAlertDisabled	boolean
VerificationLimit	int
VerifiedEmails	int
Website	string	HTTP address of your website.	http://example.com
Zip	string	Zip/postal code.	00000

AccountOverview

Basic overview of your account

Property	Type	Description	Example
AIToolsImageCount	int	Current image prompt count in subscription period
AIToolsTextCount	int	Current text prompt count in subscription period.
BlockedContactsCount	long	Number of contacts currently with blocked status of Unsubscribed, Complaint, Bounced or InActive	1000
CampaignCount	long	Number of created campaigns	10
ContactCount	long	Number of contacts	10000
CostPerThousand	decimal	Cost of 1000 emails	0.09
Credit	decimal	Current credit in Account for Pay as you go plans.	1000
InProgressCount	long	Number of messages in progress	1234
MaxContacts	int	Maximum allowed Contacts limit if it's a Sub-Account.
ReferralCount	long	Number of active referrals	10
Reputation	double	Numeric reputation	100
SubAccountCount	long	Number of created Sub-Accounts	10
TemplateCount	long	Number of available templates	10
TotalEmailsSent	long	Amount of emails sent from this Account	1000
VerificationCount	int	Current Verification count in subscription period.
VerificationLimit	int	Current Verification Limit

AdvancedOptions

Lists advanced sending options of your account.

Property	Type	Description	Example
AllowCustomHeaders	boolean	True, if you want to apply custom headers to your emails. Otherwise, false	true
AutoTextFormat	boolean	True, if text BODY of message should be created automatically. Otherwise, false	true
BccEmail	string	Email address to send a copy of all email to.	your@email.com
ConsentTrackingOnUnsubscribe	boolean
ContentTransferEncoding	string	Type of content encoding	Base64
DeliveryReason	string	Why your clients are receiving your emails.	Reason
EmailNotification	string	True, if you want to receive bounce email notifications. Otherwise, false	true
EmailNotificationForError	boolean	True, if you want bounce notifications returned. Otherwise, false	false
EnableClickTracking	boolean	True, if you want to track clicks. Otherwise, false	true
EnableContactFeatures	boolean	True, if you want to use Contact Delivery Tools. Otherwise, false
EnableLinkClickTracking	boolean	True, if you want to track by link tracking. Otherwise, false	true
EnableTemplateScripting	boolean	True, if you want to use template scripting in your emails {{}}. Otherwise, false	true
EnableUITooltips	boolean	True, if Account has tooltips active. Otherwise, false	true
EnableUnsubscribeHeader	boolean	True, if you want to enable list-unsubscribe header. Otherwise, false	true
IsOwnedByReseller	boolean	True, if this Account resells Doali Email. Otherwise, false.	false
IsSubAccount	boolean	True, if this Account is a Sub-Account. Otherwise, false	true
LogoUrl	string	URL to your logo image.	http://yourdomain.com/logo.png
LowCreditNotification	boolean	True, if you want to receive low credit email notifications. Otherwise, false	true
ManageSubscribedOnly	boolean	True, if you want to only display labels that the contact is subscribed to on your unsubscribe form. Otherwise, false	true
ManageSubscriptions	boolean	True, if you want to display your labels on your unsubscribe form. Otherwise, false	true
NotificationsEmails	string	Email addresses to send a copy of all notifications from our system. Separated by semicolon	email1@example.com;email2@example.com
PreviewMessageID	string
StaleContactInactiveDays	int	(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
StaleContactScore	int	(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
TransactionalOnUnsubscribe	boolean	True, if you want to display an option for the contact to opt into transactional email only on your unsubscribe form. Otherwise, false	true
TutorialsEnabled	boolean	True, if you want to enable Dashboard Tutotials	true
UnsubscribeNotificationEmails	string	Emails, separated by semicolon, to which the notification about contact unsubscribing should be sent to	email1@example.com;email2@example.com

BlockedContact

Blocked Contact - Contact returning Hard Bounces

Property	Type	Description	Example
DateUpdated	datetime	Last change date	2001-01-01T12:00:00
Email	string	Proper email address.	mail@example.com
FriendlyErrorMessage	string	RFC error message	Mailbox not found
Status	string	Status of the given resource	1

BouncedCategorySummary

Summary of bounced categories, based on specified date range.

Property	Type	Description	Example
AccountProblem	long	Number of messages flagged with 'Account Problem'	0
BlackListed	long	Number of blacklisted messages	1000
CodeError	long	Number of messages flagged with 'Code Error'	0
ConnectionProblem	long	Number of messages flagged with 'Connection Problem'	0
ConnectionTerminated	long	Number of messages flagged with 'Connection terminated'	0
DnsProblem	long	Number of messages flagged with 'DNS Problem'	0
GreyListed	long	Number of messages flagged with 'Grey Listed'	0
ManualCancel	long	Number of manually cancelled messages	1000
NoMailbox	long	Number of messages flagged with 'No Mailbox'	0
NotDelivered	long	Number of messages flagged with 'Not Delivered'	0
Spam	long	Number of messages marked as SPAM	1000
SpfProblem	long	Number of messages flagged with 'SPF Problem'	0
Throttled	long	Number of messages flagged with 'Throttled'	0
Timeout	long	Number of messages flagged with 'Timeout'	0
WhitelistingProblem	long	Number of messages flagged with 'WhiteListing Problem'	0

BounceType Enumeration

Name	Value	Description
Soft	0
Hard	1

Campaign

Property	Type	Description	Example
CampaignTemplates	List of CampaignTemplate
ChannelID	int	ID number of selected Channel.	123456
Name	string	Campaign's name
SendStats	boolean
SkipReshardCheck	boolean
SplitOptimization	SplitOptimization	What should be checked for choosing the winner: opens or clicks	0
SplitOptimizationMinutes	int	Number of minutes between sends during optimization period	30
Status	CampaignStatus	Name of campaign's status
Targets	Repeated list of string	List of Segment and List IDs, preceded with 'l' for Lists and 's' for Segments, comma separated	s01,l10
TimingOption	int
TrackClicks	boolean	Should the clicks be tracked? If no value has been provided, Account's default setting will be used.	true
TrackOpens	boolean	Should the opens be tracked? If no value has been provided, Account's default setting will be used.	true
TriggerChannelID	int	Which Channel's event should trigger this Campaign	12345
TriggerChannelName	string
TriggerCount	int	How many times should the campaign be sent	1
TriggerData	string	Data for filtering event campaigns such as specific link addresses.	http://api.doali.com
TriggerDate	datetime	Date of triggered send	2001-01-01T12:00:00
TriggerDelay	double	How far into the future should the campaign be sent, in minutes	20
TriggerFrequency	double	When your next automatic mail will be sent, in minutes	30
TriggerType	CampaignTriggerType	Number of event, triggering mail sending	1

CampaignChannel

Channel

Property	Type	Description	Example
ChannelID	int	ID number of selected Channel.	123456
ClickedCount	int	Total emails clicked	1000
DateAdded	datetime	Date of creation in YYYY-MM-DDThh:ii:ss format	2001-01-01T12:00:00
FailedAbuse	int	Abuses - mails sent to user without their consent	0.00
FailedCount	int	Total emails failed.	1000
IsCampaign	boolean	True, if you are sending a campaign. Otherwise, false.	true
LastActivity	datetime	Date of last activity on Account	2001-01-01T12:00:00
LastProcessed	datetime	Datetime of last action done on campaign.	2001-01-01T01:01:01
Name	string	Filename	attachment.txt
OpenedCount	int	Total emails opened.	1000
ParentChannelID	int	Id number of parent channel	123456
ParentChannelName	string
PoolName	string	Name of your custom IP Pool to be used in the sending process	My Custom Pool
PreHeader	string
RecipientCount	int	Overall number of recipients	1000
SendStats	boolean
SentCount	int	Total emails sent.	1000
SplitOptimization	SplitOptimization	What should be checked for choosing the winner: opens or clicks	0
SplitOptimizationMinutes	int	Number of minutes between sends during optimization period	30
SplitWinner	boolean
Status	CampaignStatus	Name of campaign's status
Targets	Repeated list of string	List of Segment and List IDs, preceded with 'l' for Lists and 's' for Segments, comma separated	s01,l10
TemplateChannels	List of CampaignChannel	List of CampaignTemplate for sending A-X split testing.	CampaignTemplate1, CampaignTemplate2
TemplateFromEmail	string	Default From: email address.	sender@yourdomain.com
TemplateFromName	string	Default From: name.	Sender
TemplateID	int	ID number of template.	1234
TemplateName	string	Name of template.	Template01
TemplateReplyEmail	string	Default Reply: email address.	replyto@yourdomain.com
TemplateReplyName	string	Default Reply: name.	Reply
TemplateSubject	string	Default subject of email.	Hello!
TimingOption	int
TrackClicks	boolean	Should the clicks be tracked? If no value has been provided, Account's default setting will be used.	true
TrackOpens	boolean	Should the opens be tracked? If no value has been provided, Account's default setting will be used.	true
TriggerChannelID	int	Which Channel's event should trigger this Campaign	12345
TriggerChannelName	string
TriggerCount	int	How many times should the campaign be sent	1
TriggerData	string	Data for filtering event campaigns such as specific link addresses.	http://api.doali.com
TriggerDate	datetime	Date of triggered send	2001-01-01T12:00:00
TriggerDelay	double	How far into the future should the campaign be sent, in minutes	20
TriggerFrequency	double	When your next automatic mail will be sent, in minutes	30
TriggerType	CampaignTriggerType	Number of event, triggering mail sending	1
Type	CampaignType
UnsubscribedCount	int	Total emails unsubscribed	1000
UtmCampaign	string	The utm_campaign marketing parameter appended to each link in the campaign.	campaign1
UtmContent	string	The utm_content marketing parameter appended to each link in the campaign.	content1
UtmMedium	string	The utm_medium marketing parameter appended to each link in the campaign.	medium1
UtmSource	string	The utm_source marketing parameter appended to each link in the campaign.	source1

CampaignStatus Enumeration

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

CampaignTemplate

Property	Type	Description	Example
CampaignTemplateID	int
CampaignTemplateName	string
PoolName	string	Name of your custom IP Pool to be used in the sending process	My Custom Pool
PreHeader	string
Status	CampaignStatus	Name of campaign's status
TemplateFromEmail	string	Default From: email address.	sender@yourdomain.com
TemplateFromName	string	Default From: name.	Sender
TemplateID	int	ID number of template.	1234
TemplateName	string	Name of template.	Template01
TemplateReplyEmail	string	Default Reply: email address.	replyto@yourdomain.com
TemplateReplyName	string	Default Reply: name.	Reply
TemplateSubject	string	Default subject of email.	Hello!
UtmCampaign	string	The utm_campaign marketing parameter appended to each link in the campaign.	campaign1
UtmContent	string	The utm_content marketing parameter appended to each link in the campaign.	content1
UtmMedium	string	The utm_medium marketing parameter appended to each link in the campaign.	medium1
UtmSource	string	The utm_source marketing parameter appended to each link in the campaign.	source1

CampaignTriggerType Enumeration

Name	Value	Description
SendNow	1
FutureScheduled	2
OnAdd	3
OnOpen	4
OnClick	5

CampaignType Enumeration

Name	Value	Description
SendNow	0
Automated	1
AbSplit	2

CertificateValidationStatus Enumeration

Name	Value	Description
ErrorOccured	-2
CertNotSet	0
Valid	1
NotValid	2

Channel

SMTP and HTTP API channel for grouping email delivery

Property	Type	Description
ChannelID	int	Channel identifier.
ClickedCount	int	The number of emails that have been clicked within this channel.
ClickedPercentage	double	Percentage of clicked emails out of delivered emails
Cost	decimal	The total cost for emails/attachments within this channel.
DateAdded	datetime	The date the channel was added to your account.
DeliveredPercentage	double	Percentage of delivered emails out of all emails
FailedAbuse	int	The number of emails that have been marked as abuse or complaint within this channel.
FailedAbusePercentage	double	Percentage of emails marked as abuse out of delivered emails
FailedCount	int	The number of emails that have been bounced within this channel.
FailedPercentage	double	Percentage of failed emails out of all emails
JobCount	int	The number of email jobs this channel has been used with.
LastActivity	datetime	The date the channel was last sent through.
Name	string	Descriptive name of the channel.
OpenedCount	int	The number of emails that have been opened within this channel.
OpenedPercentage	double	Percentage of opened emails out of delivered emails
RecipientCount	int	The number of emails attempted to be sent within this channel.
SentCount	int	The number of emails that have been sent within this channel.
SuppressedCount	int	The number of emails that have been stopped.
SuppressedPercentage	double	Percentage of suppressed (not delivered) emails out of all emails
UnsubscribedCount	int	The number of emails that have been unsubscribed within this channel.
UnsubscribedPercentage	double	Percentage of emails marked as unsubscribed out of delivered emails

CompressionFormat Enumeration

FileResponse compression format

Name	Value	Description
None	0	No compression
Zip	1	Zip compression

ConsentTracking Enumeration

Name	Value	Description
Unknown	0
Allow	1
Deny	2

Contact

Property	Type	Description	Example
BounceCount	int
BouncedErrorCode	int	RFC Error code	550
BouncedErrorMessage	string	RFC error message	Mailbox not found
ConsentDate	datetime	Date of consent to send this contact(s) your email. If not provided current date is used for consent.	1/1/2015 0:00:00 AM
ConsentIP	string	IP address of consent to send this contact(s) your email. If not provided your current public IP address is used for consent.	192.168.0.1
ConsentTracking	ConsentTracking	Does the contant consent to have their tracking data stored.	Allow
ContactScore	int
CreatedFromIP	string	IP address	192.168.0.1
CustomFields	Repeated list of string keys and string values	Custom contact field like companyname, customernumber, city etc. JSON serialized text like { "city":"london" }	english
DateAdded	datetime	Date of creation in YYYY-MM-DDThh:ii:ss format	2001-01-01T12:00:00
DateUpdated	datetime	Last change date	2001-01-01T12:00:00
Email	string	Proper email address.	mail@example.com
ErrorCode	int	RFC Error code	550
FirstFailedDate	datetime	Date of first failed message	2001-01-01T12:00:00
FirstName	string	First name.	Fred
FriendlyErrorMessage	string	RFC error message	Mailbox not found
IsDeleted	boolean
LastClicked	datetime
LastFailedCount	int	Number of fails in sending to this Contact	1
LastIP	string
LastName	string	Last name.	Flintstone
LastOpened	datetime	Date this contact last opened an email	2014-01-01
LastSent	datetime
Notes	string	Free form field of notes	Contact is extremely important!
Source	ContactSource	Source of URL of payment	http://
Status	ContactStatus	Status of the given resource	1
StatusChangeDate	datetime	Date of last status change.	2001-01-01T12:00:00
TotalClicked	int	Total emails clicked	1000
TotalFailed	int	Total emails failed.	1000
TotalOpened	int	Total emails opened.	1000
TotalSent	int	Total emails sent.	1000
UnsubscribedDate	datetime	Unsubscribed date in YYYY-MM-DD format	2001-01-01
WebsiteUrl	string	Website of contact	http://

ContactCollection

Collection of lists and segments

Property	Type	Description	Example
Lists	List of ContactContainer	Lists which contain the requested contact
Segments	List of ContactContainer	Segments which contain the requested contact

ContactContainer

List's or segment's short info

Property	Type	Description	Example
ID	int	ID of the list/segment
Name	string	Name of the list/segment

ContactSort Enumeration

Name	Value	Description
Unknown	0
DateAddedAsc	1	Sort by date added ascending order
DateAddedDesc	2	Sort by date added descending order
DateUpdatedAsc	3	Sort by date updated ascending order
DateUpdatedDesc	4	Sort by date updated descending order

ContactSource Enumeration

Name	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.
VerificationApi	5	Contact was added via the verification api.
FileVerificationApi	6	Contacts were added via bulk verification api.

ContactStatus Enumeration

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

ContactStatusCounts

Number of Contacts, grouped by Status;

Property	Type	Description	Example
Active	long	Number of active contacts	1000
Bounced	long	Number of bounced messages	1000
Complaint	long	Number of complaint messages	1000
Engaged	long	Number of engaged contacts	1000
Inactive	long	Number of inactive contacts	1000
NotConfirmed	long
Stale	long
Transactional	long	Number of transactional contacts	1000
Unsubscribed	long	Number of unsubscribed messages	1000

ContactUnsubscribeReasonCounts

Number of Unsubscribed or Complaint Contacts, grouped by Unsubscribe Reason;

Property	Type	Description	Example
AbuseReported	long
DeceptiveContent	long
IrrelevantContent	long
ListUnsubscribe	long
NeverConsented	long
NoLongerWant	long
ThirdParty	long
TooFrequent	long
Unknown	long

DailyLogStatusSummary

Daily summary of log status, based on specified date range.

Property	Type	Description	Example
Bounced	int	Number of bounced messages	1000
BouncedPercentage	double	Percentage of failed emails out of all emails
Clicked	int	Number of clicked messages	1000
ClickedPercentage	double	Percentage of clicked emails out of delivered emails
Complaint	int	Number of complaint messages	1000
ComplaintPercentage	double	Percentage of emails marked as abuse out of delivered emails
Date	datetime	Date in YYYY-MM-DDThh:ii:ss format	2001-01-01T12:00:00
Delivered	int	Number of delivered messages	1000
DeliveredPercentage	double	Percentage of delivered emails out of all emails
Email	int	Proper email address.	mail@example.com
Inbound	int	Number of inbound messages	1000
ManualCancel	int	Number of manually cancelled messages	1000
NotDelivered	int	Number of messages flagged with 'Not Delivered'	0
Opened	int	Number of opened messages	1000
OpenedPercentage	double	Percentage of opened emails out of delivered emails
Sms	int	Number of SMS	12
Suppressed	long
SuppressedPercentage	double	Percentage of suppressed (not delivered) emails out of all emails
Unsubscribed	int	Number of unsubscribed messages	1000
UnsubscribedPercentage	double	Percentage of emails marked as unsubscribed out of delivered emails

DomainDetail

Domain data, with information about domain records.

Property	Type	Description	Example
CertificateStatus	CertificateValidationStatus
CertificateValidationError	string
CustomBouncesDomain	string
DefaultDomain	boolean	True, if domain is used as default. Otherwise, false,
Dkim	boolean	True, if DKIM record is verified	true
DMARC	boolean
Domain	string	Name of selected domain.	example.com
IsCustomBouncesDomainDefault	boolean
IsMarkedForDeletion	boolean
IsRewriteDomainValid	boolean	True, if tracking CNAME record is verified	true
MX	boolean	True, if MX record is verified	true
Spf	boolean	True, if SPF record is verified	true
TrackingStatus	TrackingValidationStatus	0 - Validated successfully, 1 - NotValidated , 2 - Invalid, 3 - Broken (tracking was frequnetly verfied in given period and still is invalid). For statuses: 0, 1, 3 tracking will be verified in normal periods. For status 2 tracking will be verified in high frequent periods.
TrackingTypeUserRequest	TrackingType
Type	TrackingType
Verify	boolean	True, if DKIM, SPF, or tracking are still to be verified	true
VERP	boolean

EmailCredits

Detailed information about email credits

Property	Type	Description	Example
Amount	decimal	Amount of money in transaction	100
Date	datetime	Date in YYYY-MM-DDThh:ii:ss format	2001-01-01T12:00:00
Notes	string	Free form field of notes	Contact is extremely important!
Source	string	Source of URL of payment	http://

EmailJobFailedStatus

Property	Type	Description	Example
Address	string
Category	string
Error	string
ErrorCode	int	RFC Error code	550

EmailJobStatus

Property	Type	Description	Example
AbuseReports	List of string
AbuseReportsCount	int
Clicked	List of string	Number of clicked messages	1000
ClickedCount	int	Total emails clicked	1000
Delivered	List of string	Number of delivered messages	1000
DeliveredCount	int
Failed	List of EmailJobFailedStatus
FailedCount	int	Total emails failed.	1000
ID	string	ID number of your attachment	123456
MessageIDs	List of string	List of all MessageIDs for this job.
Opened	List of string	Number of opened messages	1000
OpenedCount	int	Total emails opened.	1000
Pending	List of string
PendingCount	int
RecipientsCount	int
Sent	List of string
SentCount	int	Total emails sent.	1000
Status	string	Name of status: submitted, complete, in_progress
Unsubscribed	List of string	Number of unsubscribed messages	1000
UnsubscribedCount	int	Total emails unsubscribed	1000

EmailSend

Property	Type	Description	Example
MessageID	string	Unique identifier for this email.	-HHGPM_9RPhSMiaJq_ab4g3
TransactionID	string	ID number of transaction	TransactionID

EmailStatus

Status information of the specified email

Property	Type	Description	Example
Date	datetime	Date the email was submitted.
DateClicked	datetime	Date when the email changed the status to 'clicked'	2001-01-01T12:00:00
DateOpened	datetime	Date when the email changed the status to 'opened'	2001-01-01T12:00:00
DateSent	datetime	Date when the email was sent	2001-01-01T12:00:00
EnvelopeFrom	string	Envelope from address
ErrorCategory	MessageCategoryEnum	Category of bounce or error
ErrorMessage	string	Detailed error or bounced message.
From	string	Email address this email was sent from.
Status	LogJobStatus	Value of email's status
StatusChangeDate	datetime	Date of last status change.	2001-01-01T12:00:00
StatusName	string	Name of email's status
To	string	Email address this email was sent to.
TransactionID	GUID	ID number of transaction	TransactionID

EmailValidationResult

Property	Type	Description	Example
Account	string
Disposable	boolean
Domain	string	Name of selected domain.	example.com
Email	string	Proper email address.	mail@example.com
Reason	string	Reason for blocking (1 - bounced, 2 - unsubscribed, 3 - spam).	1
Result	EmailValidationStatus
Role	boolean
SuggestedSpelling	string

EmailValidationStatus Enumeration

Name	Value	Description
None	0
Valid	1
Unknown	2
Risky	3
Invalid	4

EmailView

Email details formatted in json

Property	Type	Description	Example
Body	string	Body (HTML, otherwise plain text) of email
From	string	From email address
Subject	string	Default subject of email.	Hello!

EncodingType Enumeration

Encoding type for the email headers

Name	Value	Description
UserProvided	-1	Encoding of the email is provided by the sender and not altered.
None	0	No endcoding is set for the email.
Raw7bit	1	Encoding of the email is in Raw7bit format.
Raw8bit	2	Encoding of the email is in Raw8bit format.
QuotedPrintable	3	Encoding of the email is in QuotedPrintable format.
Base64	4	Encoding of the email is in Base64 format.
Uue	5	Encoding of the email is in Uue format.

EventLog

Event logs for selected date range

Property	Type	Description	Example
From	datetime	Starting date for search in YYYY-MM-DDThh:mm:ss format.	2001-01-01T01:01:01
Recipients	List of RecipientEvent	Number of recipients	1234
To	datetime	Ending date for search in YYYY-MM-DDThh:mm:ss format.	2001-01-01T01:01:01

Export

Record of exported data from the system.

Property	Type	Description	Example
DateAdded	datetime	Date the export was created.
ExportStatus	ExportStatus	Status of the export	Ready
ExportType	ExportType	Type of export	123456
Filename	string	Name of the exported file.	myexportedfile.csv
Info	string	Long description of the export.	Sent in last 35 days.
Link	string	Link to download the export.	https://api.doali.com/userfile/xxx/export/xxx-Emaillog.csv
LogFrom	datetime	Log start date (for Type = Log only).
LogTo	datetime	Log end date (for Type = Log only).
PublicExportID	GUID	ID of the exported file	E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F

ExportFileFormats Enumeration

Format of the exported file.

Name	Value	Description
Csv	1	Export in comma separated values format.
Xml	2	Export in xml format.
Json	3	Export in json format.

ExportLink

Property	Type	Description	Example
Link	string	Direct URL to the exported file
PublicExportID	GUID	ID of the exported file	E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F

ExportStatus Enumeration

Current status of the export.

Name	Value	Description
Error	-1	Export had an error and can not be downloaded.
Loading	0	Export is currently loading and can not be downloaded.
Ready	1	Export is currently available for downloading.
Expired	2	Export is no longer available for downloading.

ExportType Enumeration

Type of export.

Name	Value	Description
Log	1	Export contains detailed email log information.
Contact	2	Export contains detailed contact information.
Campaign	3	Export contains detailed campaign information.
LinkTracking	4	Export contains detailed link tracking information.
Survey	5	Export contains detailed survey information.

File

File information

Property	Type	Description	Example
ContentType	string	Content type of the file.	image/jpeg
DateAdded	datetime	Date of creation in YYYY-MM-DDThh:ii:ss format	2001-01-01T12:00:00
ExpirationDate	datetime	Date when the file will be deleted from your Account.
FileName	string	Name of your file including extension.	filename.txt
Size	int	Size of your attachment (in bytes).	100

InboundOptions

Lists inbound options of your account.

Property	Type	Description	Example
HubCallbackUrl	string	URL used for tracking action of inbound emails	http://
InboundContactsOnly	boolean	True, if you want inbound email to only process contacts from your Account. Otherwise, false	true
InboundDomain	string	Domain you use as your inbound domain	yourdomain.com

IntervalType Enumeration

Name	Value	Description
Summary	0	Daily overview
Hourly	1	Hourly, detailed information

LinkTrackingDetails

Object containig tracking data.

Property	Type	Description	Example
Count	int	Number of items.	100
MoreAvailable	boolean	True, if there are more detailed data available. Otherwise, false	true
TrackedLink	List of TrackedLink

List

List of Lists, with detailed data about its contents.

Property	Type	Description	Example
AllowUnsubscribe	boolean	True: Allow unsubscribing from this list. Otherwise, false	true/false
Count	int	This count is no longer supported and will always be 0. Use /contact/count instead.
DateAdded	datetime	Date of creation in YYYY-MM-DDThh:ii:ss format	2001-01-01T12:00:00
ListID	int	ID number of selected list.	1234
ListName	string	Name of your list.	My List 1
PublicListID	GUID	ID code of list. Please note that this is different from the listid field.	E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F
Rule	string	Query used for filtering.	Status%20=%20Engaged
TrackHistory	boolean

Log

Logs for selected date range

Property	Type	Description	Example
From	datetime	Starting date for search in YYYY-MM-DDThh:mm:ss format.	2001-01-01T01:01:01
Recipients	List of Recipient	Number of recipients	1234
To	datetime	Ending date for search in YYYY-MM-DDThh:mm:ss format.	2001-01-01T01:01:01

LogEventStatus Enumeration

Name	Value	Description
ReadyToSend	1	Email is queued for sending.
WaitingToRetry	2	Email has soft bounced and is scheduled to retry.
Sending	3	Email is currently sending.
Error	4	Email has errored or bounced for some reason.
Sent	5	Email has been successfully delivered.
Opened	6	Email has been opened by the recipient.
Clicked	7	Email has had at least one link clicked by the recipient.
Unsubscribed	8	Email has been unsubscribed by the recipient.
AbuseReport	9	Email has been complained about or marked as spam by the recipient.

LogJobStatus Enumeration

Name	Value	Description
All	0	All emails
ReadyToSend	1	Email has been submitted successfully and is queued for sending.
WaitingToRetry	2	Email has soft bounced and is scheduled to retry.
Sending	3	Email is currently sending.
Error	4	Email has errored or bounced for some reason.
Sent	5	Email has been successfully delivered.
Opened	6	Email has been opened by the recipient.
Clicked	7	Email has had at least one link clicked by the recipient.
Unsubscribed	8	Email has been unsubscribed by the recipient.
AbuseReport	9	Email has been complained about or marked as spam by the recipient.

LogStatusSummary

Summary of log status, based on specified date range.

Property	Type	Description	Example
Bounced	long	Number of bounced messages	1000
Clicked	long	Number of clicked messages	1000
ClickedPercentage	double	Percentage of clicked emails out of delivered emails
Complaints	long	Number of complaint messages	1000
Delivered	long	Number of delivered messages	1000
DeliveredPercentage	double	Percentage of delivered emails out of all emails
Duration	double	Overall duration
EmailTotal	long	Number of emails	1234
FailedAbusePercentage	double	Percentage of emails marked as abuse out of delivered emails
FailedPercentage	double	Percentage of failed emails out of all emails
From	datetime	Starting date for search in YYYY-MM-DDThh:mm:ss format.	2001-01-01T01:01:01
Inbound	long	Number of inbound messages	1000
InProgress	long	Number of messages in progress	1234
ManualCancel	long	Number of manually cancelled messages	1000
NotDelivered	long	Number of messages flagged with 'Not Delivered'	0
NotDeliveredCancelled	long
Opened	long	Number of opened messages	1000
OpenedPercentage	double	Percentage of opened emails out of delivered emails
ReadyToSend	long
Recipients	long	Number of recipients	1234
SmsTotal	long	Number of SMS	12
Suppressed	long
SuppressedPercentage	double	Percentage of suppressed (not delivered) emails out of all emails
TemplateChannel	boolean	ID number of template used	1234
To	datetime	Ending date for search in YYYY-MM-DDThh:mm:ss format.	2001-01-01T01:01:01
Unsubscribed	long	Number of unsubscribed messages	1000
UnsubscribedPercentage	double	Percentage of emails marked as unsubscribed out of delivered emails
WaitingToRetry	long

LogSummary

Overall log summary information.

Property	Type	Description
BouncedCategorySummary	BouncedCategorySummary	Summary of bounced categories, based on specified date range.
DailyLogStatusSummary	List of DailyLogStatusSummary	Daily summary of log status, based on specified date range.
LogStatusSummary	LogStatusSummary	Summary of log status, based on specified date range.
SubaccountSummary	SubaccountSummary

MessageCategory Enumeration

Name	Value	Description
Unknown	0
Ignore	1
Spam	2	Number of messages marked as SPAM
BlackListed	3	Number of blacklisted messages
NoMailbox	4	Number of messages flagged with 'No Mailbox'
GreyListed	5	Number of messages flagged with 'Grey Listed'
Throttled	6	Number of messages flagged with 'Throttled'
Timeout	7	Number of messages flagged with 'Timeout'
ConnectionProblem	8	Number of messages flagged with 'Connection Problem'
SPFProblem	9	Number of messages flagged with 'SPF Problem'
AccountProblem	10	Number of messages flagged with 'Account Problem'
DNSProblem	11	Number of messages flagged with 'DNS Problem'
NotDeliveredCancelled	12
CodeError	13	Number of messages flagged with 'Code Error'
ManualCancel	14	Number of manually cancelled messages
ConnectionTerminated	15	Number of messages flagged with 'Connection terminated'
NotDelivered	16	Number of messages flagged with 'Not Delivered'

MessageCategoryEnum Enumeration

Name	Value	Description
Unknown	0
Ignore	1
Spam	2	Number of messages marked as SPAM
BlackListed	3	Number of blacklisted messages
NoMailbox	4	Number of messages flagged with 'No Mailbox'
GreyListed	5	Number of messages flagged with 'Grey Listed'
Throttled	6	Number of messages flagged with 'Throttled'
Timeout	7	Number of messages flagged with 'Timeout'
ConnectionProblem	8	Number of messages flagged with 'Connection Problem'
SPFProblem	9	Number of messages flagged with 'SPF Problem'
AccountProblem	10	Number of messages flagged with 'Account Problem'
DNSProblem	11	Number of messages flagged with 'DNS Problem'
NotDeliveredCancelled	12
CodeError	13	Number of messages flagged with 'Code Error'
ManualCancel	14	Number of manually cancelled messages
ConnectionTerminated	15	Number of messages flagged with 'Connection terminated'
NotDelivered	16	Number of messages flagged with 'Not Delivered'

NotificationType Enumeration

Name	Value	Description
All	0	Both, email and web, notifications
Email	1	Only email notifications
Web	2	Only web notifications

Payment

Detailed information about existing money transfers.

Property	Type	Description	Example
Amount	decimal	Amount of money in transaction	100
Date	datetime	Date in YYYY-MM-DDThh:ii:ss format	2001-01-01T12:00:00
DiscountPercent	decimal
RegularAmount	decimal
Source	string	Source of URL of payment	http://

Profile

Basic information about your profile

Property	Type	Description	Example
Address1	string	First line of address.	12 Granite Road
Address2	string	Second line of address.	Apartment B
City	string	City.	Bedrock
Company	string	Company name.	Slate
CountryID	int	Numeric ID of country. A file with the list of countries is available here	12345
CountryISO	string	Two letter ISO 3166-1 code of the country
DeliveryReason	string	Why your clients are receiving your emails.	Reason
Email	string	Proper email address.	mail@example.com
FirstName	string	First name.	Fred
LastName	string	Last name.	Flintstone
LogoUrl	string	URL to your logo image.	http://yourdomain.com/logo.png
MarketingConsent	boolean	True if you want to receive newsletters from Doali Email. Otherwise, false. Empty to leave the current value.	true/false
Phone	string	Phone number	1234567890
State	string	State or province.	CA
TaxCode	string	Code used for tax purposes.
Website	string	HTTP address of your website.	http://example.com
Zip	string	Zip/postal code.	00000

Recipient

Detailed information about message recipient

Property	Type	Description	Example
BounceType	BounceType
Channel	string	Name of selected Channel.	Channel01
ContactLastError	string	Recipient's last bounce error because of which this e-mail was suppressed	The email address does not exist
Date	datetime	Creation date
DateClicked	datetime	Date when the email changed the status to 'clicked'	2001-01-01T12:00:00
DateOpened	datetime	Date when the email changed the status to 'opened'	2001-01-01T12:00:00
DateSent	datetime	Date when the email was sent	2001-01-01T12:00:00
EnvelopeFrom	string
FromEmail	string	Default From: email address.	sender@yourdomain.com
IPAddress	string
IsSms	boolean	True, if message is SMS. Otherwise, false	true
JobID	string	ID of certain mail job
Message	string	Content of message, HTML encoded	Lorem ipsum
MessageCategory	string	Name of message category
MessageCategoryID	MessageCategory	ID of message category
MessageSid	string	Comma separated ID numbers of messages.	12345678,1234567890
MsgID	string	ID number of selected message.	ABCDE_9RPhSWiaJq_ab1g1
NextTryOn	datetime	Date of next try	2001-01-01T12:00:00
ShowCategory	boolean	True, if message category should be shown. Otherwise, false	true
SmsUpdateRequired	boolean	True, if message is a SMS and status is not yet confirmed. Otherwise, false	false
Status	string	Name of recipient's status: Submitted, ReadyToSend, WaitingToRetry, Sending, Bounced, Sent, Opened, Clicked, Unsubscribed, AbuseReport
StatusChangeDate	datetime	Date of last status change.	2001-01-01T12:00:00
Subject	string	Default subject of email.	Hello!
TextMessage	string	Content of message	Lorem ipsum
To	string	Ending date for search in YYYY-MM-DDThh:mm:ss format.	2001-01-01T01:01:01

RecipientEvent

Detailed information about message recipient

Property	Type	Description	Example
Channel	string	Name of selected Channel.	Channel01
ChannelID	int	ID number of selected Channel.	123456
EventDate	datetime	Creation date
EventType	string	Name of recipient's status: Submitted, ReadyToSend, WaitingToRetry, Sending, Bounced, Sent, Opened, Clicked, Unsubscribed, AbuseReport
FromEmail	string	Default From: email address.	sender@yourdomain.com
IPAddress	string
IPPoolName	string
JobID	string	ID of certain mail job
Message	string	Content of message, HTML encoded	Lorem ipsum
MessageCategory	string	Name of message category
MsgID	string	ID number of selected message.	ABCDE_9RPhSWiaJq_ab1g1
NextTryOn	datetime	Date of next try	2001-01-01T12:00:00
Subject	string	Default subject of email.	Hello!
To	string	Ending date for search in YYYY-MM-DDThh:mm:ss format.	2001-01-01T01:01:01

Referral

Referral details for this account.

Property	Type	Description	Example
CurrentReferralCount	long	Number of active referrals.	5
CurrentReferralCredit	decimal	Current amount of dolars you have from referring.	10
NewReferralsToday	int
ReferralProgramPeriodMonths	int
TotalPayout	decimal

ReputationDetail

Detailed sending reputation of your account.

Property	Type	Description	Example
AbusePercent	double	Percent of Complaining users - those, who do not want to receive email from you.	0.00
AverageSpamScore	double	Penalty from messages marked as spam.	0
ClickedPercent	double
FailedSpamPercent	double	Percent of Bounced users	0.00
Impact	ReputationImpact	Overall reputation impact, based on the most important factors.
OpenedPercent	double
UnknownUsersPercent	double	Percent of Unknown users - users that couldn't be found	0.00

ReputationHistory

Reputation history of your account.

Property	Type	Description	Example
AbusePercent	double	Percent of Complaining users - those, who do not want to receive email from you.	0.00
AverageSpamScore	double	Penalty from messages marked as spam.	0
ClickedPercent	double
DateCreated	datetime	Creation date.	2001-01-01T12:00:00
OpenedPercent	double
RepEmailsSent	double	Number of emails included in the current reputation score.	0
Reputation	double	Numeric reputation	100
SetupScore	double	Points from proper setup of your Account	0
UnknownUsersPercent	double	Percent of Unknown users - users that couldn't be found	0.00

ReputationImpact

Overall reputation impact, based on the most important factors.

Property	Type	Description	Example
Abuse	double	Abuses - mails sent to user without their consent	0.00
AverageSpamScore	double	Penalty from messages marked as spam.	0
Clicked	double	Number of clicked messages	1000
Opened	double	Number of opened messages	1000
ServerFilter	double	Content analysis.	0.00
UnknownUsers	double	Users, that could not be reached.	0.00

Segment

Information about Contact Segment, selected by RULE.

Property	Type	Description	Example
History	List of SegmentHistory	History of segment information.
LastCount	long	This count is no longer supported and will always be 0. Use /contact/count instead.
Name	string	Filename	attachment.txt
Rule	string	Query used for filtering.	Status%20=%20Engaged
SegmentID	int	ID number of your segment.	1234
TrackHistory	boolean

SegmentHistory

Segment History

Property	Type	Description	Example
Count	long	Number of items.	100
Day	int	Date in YYYY-MM-DD format	2001-01-01
SegmentHistoryID	int	ID number of history.	1234567
SegmentID	int	ID number of your segment.	1234

SendingPermission Enumeration

Controls the Sub-Account's sending permissions. Main Account's always have All.

Name	Value	Description
None	0	Sending not allowed.
Smtp	1	Allow sending via SMTP only.
HttpApi	2	Allow sending via HTTP API only.
SmtpAndHttpApi	3	Allow sending via SMTP and HTTP API.
Interface	4	Allow sending via the website interface only.
SmtpAndInterface	5	Allow sending via SMTP and the website interface.
HttpApiAndInterface	6	Allow sendnig via HTTP API and the website interface.
UseAccessLevel	16	Use access level sending permission.
All	255	Sending allowed via SMTP, HTTP API and the website interface.

SpamCheck

Spam check of specified message.

Property	Type	Description	Example
ChannelName	string	Name of selected channel.	Channel01
Date	datetime	Date in YYYY-MM-DDThh:ii:ss format	2001-01-01T12:00:00
FromEmail	string	Default From: email address.	sender@yourdomain.com
MsgID	string	ID number of selected message.	ABCDE_9RPhSWiaJq_ab1g1
Rules	List of SpamRule
Subject	string	Default subject of email.	Hello!
TotalScore	string	Total spam score from	5.5

SpamRule

Single spam score

Property	Type	Description	Example
Description	string	Description of rule.	Very long subject, possibly filled up with random
Key	string	Name of rule	JAM_LONG_SUBJECT
Score	string	Spam score	2.5

SplitOptimization Enumeration

Name	Value	Description
Opened	0	Number of opened messages
Clicked	1	Number of clicked messages

SubAccount

Detailed information about Sub-Account.

Property	Type	Description	Example
AbusePercent	double	Percent of Complaining users - those, who do not want to receive email from you.	0.00
ContactsCount	int
DailySendLimit	long	Amount of emails Account can send daily	100000
Email	string	Proper email address.	mail@example.com
EmailCredits	string	Amount of email credits	1000
EmailSizeLimit	int	Maximum size of email including attachments in MB's	10
EnablePrivateIPRequest	boolean	True, if Account can request for private IP on its own. Otherwise, false	true
FailedSpamPercent	double	Percent of Bounced users	0.00
HasModify2FA	boolean
LastActivity	datetime	Date of last activity on Account	2001-01-01T12:00:00
MailerID	string	ID number of mailer	-9
MaxContacts	int	Maximum number of contacts the Account can have	100000
MonthlyEmailSent	int	Emails sent this month
MonthlyRefillCredits	double	Amount of credits added to Account automatically	1000
PoolName	string	Name of your custom IP Pool to be used in the sending process	My Custom Pool
PublicAccountID	string	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
Reputation	double	Numeric reputation	100
RequiresEmailCredits	boolean	True, if Account needs credits to send emails. Otherwise, false	true
SendingPermission	SendingPermission	Sending permission setting for Account	All
Status	string	Account's current status.
TotalEmailsSent	long	Amount of emails sent from this Account	1000
UnknownUsersPercent	double	Percent of Unknown users - users that couldn't be found	0.00
ValidSenderDomainOnly	boolean

SubAccountSettings

Detailed settings of Sub-Account.

Property	Type	Description	Example
Allow2FA	boolean	True, if you want to allow two-factor authentication. Otherwise, false.
DailySendLimit	int	Amount of emails Account can send daily	100000
Email	string	Proper email address.	mail@example.com
EmailSizeLimit	int	Maximum size of email including attachments in MB's	10
EnableContactFeatures	boolean	True, if you want to use Contact Delivery Tools. Otherwise, false
EnablePrivateIPRequest	boolean	True, if Account can request for private IP on its own. Otherwise, false	true
MaxContacts	int	Maximum number of contacts the Account can have	100000
MonthlyRefillCredits	double	Amount of credits added to Account automatically	1000
PoolName	string	Name of your custom IP Pool to be used in the sending process	My Custom Pool
PublicAccountID	string	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
RequiresEmailCredits	boolean	True, if Account needs credits to send emails. Otherwise, false	true
SendingPermission	SendingPermission	Sending permission setting for Account	All
ValidSenderDomainOnly	boolean

SubaccountSummary

Property	Type	Description	Example
EmailsSentThisMonth	int
EmailsSentToday	int

SupportPlan Enumeration

Add-on support options for your Account.

Name	Value	Description
Free	0	Free support.
Priority	1	In-app support option for $1/day.
Premium	2	In-app real-time chat support option for $7/day.

TagType Enumeration

Name	Value	Description
Template	0
LandingPage	1

Template

Property	Type	Description	Example
BodyAmp	string	AMP code of email (needs escaping).	<BODY><H1>Hello!</H1></BODY>
BodyHtml	string	HTML code of email (needs escaping).	<BODY><H1>Hello!</H1></BODY>
BodyText	string	Text body of email.	Hello%20World
Css	string	CSS style	body:{color:black;}
DateAdded	datetime	Date of creation in YYYY-MM-DDThh:ii:ss format	2001-01-01T12:00:00
EditorMetaData	string
FromEmail	string	Default From: email address.	sender@yourdomain.com
FromName	string	Default From: name.	Sender
Name	string	Filename	attachment.txt
OriginalTemplateID	int	ID number of original template.	123
OriginalTemplateName	string
Subject	string	Default subject of email.	Hello!
Tags	List of string	Template's Tags
TemplateID	int	ID number of template.	1234
TemplateScope	TemplateScope	Enum: 0 - private, 1 - public	1
TemplateType	TemplateType	0 for API connections	0

TemplateList

List of templates (including drafts)

Property	Type	Description
DraftTemplate	List of Template	List of draft templates
DraftTemplatesCount	int	Total of draft templates
Templates	List of Template	List of templates
TemplatesCount	int	Total of templates

TemplateOrder Enumeration

Name	Value	Description
DateAddedAscending	0
DateAddedDescending	1
NameAscending	2
NameDescending	3
DateModifiedAscending	4
DateModifiedDescending	5

TemplateScope Enumeration

Name	Value	Description
Private	0	Template is available for this account only.
Public	1	Template is available for this account and it's sub-accounts.

TemplateTag

Tag used for tagging multiple Templates

Property	Type	Description	Example
Name	string	Tag's value
Type	TagType	Tag type

TemplateTagList

A list of your personal and global Template Tags

Property	Type	Description	Example
GlobalTags	List of TemplateTag	List of globally available Tags
Tags	List of TemplateTag	List of personal Tags

TemplateType Enumeration

Name	Value	Description
RawHTML	0	Template supports any valid HTML
DragDropEditor	1	Template is created for email and can only be modified in the drag and drop email editor
LandingPageEditor	2	Template is created for landing page and can only be modified in the drag and drop langing page editor
TemplateEditor	3	Template is created for email, and can be modified only by block editor.
FormTemplate	4	Template is created for forms
LandingPageTemplate	5	Template is created for new landing page editor
PaymentConfirmationTemplate	6	Template sent as payment confirmation in Checkouts
LandingPageProductTemplate	7	Template used in Product LandingPage
LandingPageCheckoutTemplate	8	Template used in Checkout screen LandingPage
LandingPagePaymentConfirmationTemplate	9	Template used as payment confirmation Landing

TrackedLink

Information about tracking link and its clicks.

Property	Type	Description	Example
Clicks	string	Number of clicks	10
Link	string	URL clicked	http://
Percent	string	Percent of clicks	10%

TrackingType Enumeration

HTTP or HTTPS Protocal used for link tracking.

Name	Value	Description
Http	0	Tracking protocal that is not encrypted.
ExternalHttps	1	Tracking protocal using an external SSL Certificate for encryption.
InternalCertHttps	2	Tracking protocal using an internal SSL Certificate for encyrption.
LetsEncryptCert	3	Tracking protocal using LetsEncrypt Certificate for encryption.

TrackingValidationStatus Enumeration

Status of ValidDomain to determine how often tracking validation should be performed.

Name	Value	Description
Validated	0
NotValidated	1
Invalid	2
Broken	3

Usage

Account usage

Property	Type	Description	Example
Email	string	Proper email address.	mail@example.com
IsSubAccount	boolean	True, if this Account is a Sub-Account. Otherwise, false	true
List	List of UsageData
VerificationLimit	int

UsageData

Detailed data about daily usage

Property	Type	Description	Example
AttachmentCost	decimal
AttachmentCount	int	Number of attachments sent	10
AttachmentsSize	long	Size of attachments sent	1024
ContactCost	decimal	Daily cost of Contact Delivery Tools	12.34
ContactCount	long	Number of contacts	10000
Cost	decimal	Calculated cost of sending	12.34
Date	datetime	Date in YYYY-MM-DDThh:ii:ss format	2001-01-01T12:00:00
EmailCost	decimal
EmailCount	int
EmailCreditsCost	int	Cost of email credits	.0001
InboundCount	int	Number of inbound emails	1000
InboundEmailCost	decimal
InboundEmailCount	int
JobCount	int	Number of finished tasks	10
LogCost	decimal
PrivateIPCost	decimal
PrivateIPCount	int	Number of pricate IPs	2
RecipientCost	decimal
RecipientCount	int	Overall number of recipients	1000
SmsCost	decimal	Overall cost of SMS	1.23
SmsCount	int	Number of SMS	12
SupportCost	decimal
VerificationCost	decimal
VerificationCount	int

ValidationError

Property	Type	Description	Example
Error	string
TXTRecord	string

ValidationStatus

Property	Type	Description	Example
Errors	List of ValidationError
IsValid	boolean
Log	string

ValidEmail

Property	Type	Description	Example
Email	string	Proper email address.	mail@example.com
Validated	boolean
ValidEmailID	int

Webhook

Notification webhook setting

Property	Type	Description	Example
DateCreated	datetime	Creation date.	2001-01-01T12:00:00
DateUpdated	datetime	Last change date	2001-01-01T12:00:00
IsEnabled	boolean
Name	string	Filename	attachment.txt
NotificationForAbuseReport	boolean
NotificationForClicked	boolean
NotificationForError	boolean
NotificationForOpened	boolean
NotificationForSent	boolean
NotificationForUnsubscribed	boolean
NotifyOncePerEmail	boolean
URL	string	URL of notification.	http://address.for.notification.com
WebhookID	string	Public webhook ID

WebNotificationOptions

Lists web notification options of your account.

Property	Type	Description	Example
WebNotificationForAbuse	boolean	True, if you want to send web notifications for complaint email. Otherwise, false	true
WebNotificationForClicked	boolean	True, if you want to send web notifications for clicked email. Otherwise, false	true
WebNotificationForError	boolean	True, if you want to send web notifications for bounced email. Otherwise, false	true
WebNotificationForOpened	boolean	True, if you want to send web notifications for opened email. Otherwise, false	true
WebNotificationForSent	boolean	True, if you want to send web notifications for sent email. Otherwise, false	true
WebnotificationForUnsubscribed	boolean	True, if you want to send web notifications for unsubscribed email. Otherwise, false	true
WebNotificationNotifyOncePerEmail	boolean	True, if you want to receive notifications for each type only once per email. Otherwise, false	true
WebNotificationUrl	string	URL address to receive web notifications to parse and process.	http://