API Documentation

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

Most of API requests should be sent using an HTTP GET method. If a method needs sending using an HTTP POST method, it is designated in the method description.

To start using this API, you will need your API Key (available here). Remember to keep it safe.

UseFull Path for API connection
Base URLPathParameters
Elastic Emailhttps://api.elasticemail.com/v2/category/action?param1=value1&param2=value2
Private Branding*https://api.yourdomain.com
Examplehttps://api.elasticemail.com/v2/contact/list?apikey=your-apikey

* You can create a CNAME in your DNS software and turn on private branding on your Account screen to brand api calls for your customers

Common API Calls:

Interface Libraries for this API have been written for several languages. Access them along with code samples here: http://help.elasticemail.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
accessLevelAccessLevelYesLevel of access (permission) to our API.
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
tokenNamestringYesName of the AccessToken for ease of reference.

Returns

{"success": true, "data": AccessToken key }

OR

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

Example copy link

https://api.elasticemail.com/v2/accesstoken/add?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&tokenName=My Token&accessLevel=

Delete

/AccessToken/Delete

Permanently delete AccessToken from your Account.

Parameters

Security

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
tokenNamestringYesName of the AccessToken for ease of reference.

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/accesstoken/delete?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&tokenName=My Token

List

/AccessToken/List

List all the AccessToken's in your Account.

Parameters

Security

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey 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.elasticemail.com/v2/accesstoken/list?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3

Update

/AccessToken/Update

Update AccessToken with a new name or AccessLevel.

Parameters

Security

Access Level

Name Type Required? Default value Description
accessLevelAccessLevelYesLevel of access (permission) to our API.
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
tokenNamestringYesName of the AccessToken for ease of reference.
newTokenNamestringNonullNew name of the AccessToken.

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/accesstoken/update?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&tokenName=My Token&accessLevel=&newTokenName=My Token

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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
supportPlanSupportPlanYes

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/account/adddedicatedsupport?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&supportPlan=

AddSubAccount

/Account/AddSubAccount

Create new subaccount and provide most important data about it.

Parameters

ModifySubAccounts

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
confirmPasswordstringYesRepeat new password.
emailstringYesProper email address.
passwordstringYesCurrent password.
allow2fabooleanNofalseTrue, if you want to allow two-factor authentication. Otherwise, false.
dailySendLimitintNonullAmount of emails Account can send daily
emailSizeLimitintNo10Maximum size of email including attachments in MB's
enableContactFeaturesbooleanNonullPrivate 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
enablePrivateIPRequestbooleanNotrueTrue, if Account can request for private IP on its own. Otherwise, false
maxContactsintNo0Maximum number of contacts the Account can have
poolNamestringNonullName of your custom IP Pool to be used in the sending process
requiresEmailCreditsbooleanNofalseTrue, if Account needs credits to send emails. Otherwise, false
returnUrlstringNonullURL to navigate to after Account creation
sendActivationbooleanNofalseTrue, if you want to send activation email to this Account. Otherwise, false
sendingPermissionSendingPermissionNonullSending permission setting for Account

Returns

{"success": true, "data": Sub-account's ApiKey }

OR

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

Example copy link

https://api.elasticemail.com/v2/account/addsubaccount?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&email=mail@example.com&password=********&confirmPassword=********&allow2fa=&requiresEmailCredits=true&maxContacts=100000&enablePrivateIPRequest=true&sendActivation=false&returnUrl=http://yourdomain.com&sendingPermission=All&enableContactFeatures=&poolName=My Custom Pool&emailSizeLimit=10&dailySendLimit=100000

AddSubAccountCredits

/Account/AddSubAccountCredits

Add email credits to a sub-account

Parameters

ModifySubAccounts

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
creditsintYesAmount of credits to add
notesstringYesSpecific notes about the transaction
publicAccountIDstringNonullPublic key of sub-account to add credits to. Use subAccountEmail or publicAccountID not both.
subAccountEmailstringNonullEmail address of Sub-Account

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/account/addsubaccountcredits?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&credits=&notes=&subAccountEmail=mail@example.com&publicAccountID=

AddWebhook

/Account/AddWebhook

Add notifications webhook

Parameters

ModifyWebNotifications

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
namestringYesFilename
webNotificationUrlstringYesURL address to receive web notifications to parse and process.
notificationForAbuseReportbooleanNonull
notificationForClickedbooleanNonull
notificationForErrorbooleanNonull
notificationForOpenedbooleanNonull
notificationForSentbooleanNonull
notificationForUnsubscribedbooleanNonull
notifyOncePerEmailbooleanNonull

Returns

{"success": true, "data": string }

OR

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

Example copy link

https://api.elasticemail.com/v2/account/addwebhook?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
confirmEmailstringYesNew email address.
newEmailstringYesNew email address.
sourceUrlstringNo"https://elasticemail.com/account/"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.elasticemail.com/v2/account/changeemail?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
confirmPasswordstringYesRepeat new password.
newPasswordstringYesNew password for Account.
currentPasswordstringNonullCurrent password.
resetApiKeybooleanNofalse

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/account/changepassword?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&newPassword=********&confirmPassword=********&resetApiKey=&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
confirmPasswordstringYesRepeat new password.
newPasswordstringYesNew password for Account.
subAccountEmailstringYesEmail address of Sub-Account
resetApiKeybooleanNofalse

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/account/changesubaccountpassword?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&newPassword=********&confirmPassword=********&subAccountEmail=mail@example.com&resetApiKey=

DeleteSubAccount

/Account/DeleteSubAccount

Deletes specified Subaccount

Parameters

ModifySubAccounts

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
publicAccountIDstringNonullPublic key of sub-account to delete. Use subAccountEmail or publicAccountID not both.
subAccountEmailstringNonullEmail address of Sub-Account

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/account/deletesubaccount?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&subAccountEmail=mail@example.com&publicAccountID=

DeleteWebhook

/Account/DeleteWebhook

Delete notifications webhook

Parameters

ModifyWebNotifications

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
webhookIDstringYes

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/account/deletewebhook?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&webhookID=

GetSubAccountApiKey

/Account/GetSubAccountApiKey

Returns API Key for the given Sub Account.

Parameters

ViewSubAccounts

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
publicAccountIDstringNonullPublic key of sub-account to retrieve sub-account API Key. Use subAccountEmail or publicAccountID not both.
subAccountEmailstringNonullEmail address of Sub-Account

Returns

{"success": true, "data": Sub-account's ApiKey }

OR

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

Example copy link

https://api.elasticemail.com/v2/account/getsubaccountapikey?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&subAccountEmail=mail@example.com&publicAccountID=

GetSubAccountList

/Account/GetSubAccountList

Lists all of your subaccounts

Parameters

ViewSubAccounts

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
emailstringNonullProper email address.
limitintNo0Maximum number of returned items.
offsetintNo0How 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.elasticemail.com/v2/account/getsubaccountlist?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&limit=100&offset=20&email=mail@example.com

Load

/Account/Load

Loads your account. Returns detailed information about your account.

Parameters

ViewAccount

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey 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.elasticemail.com/v2/account/load?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3

LoadAdvancedOptions

/Account/LoadAdvancedOptions

Load advanced options of your account

Parameters

ViewSettings

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey 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.elasticemail.com/v2/account/loadadvancedoptions?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3

LoadEmailCreditsHistory

/Account/LoadEmailCreditsHistory

Lists email credits history

Parameters

ViewBilling

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey 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.elasticemail.com/v2/account/loademailcreditshistory?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3

LoadInboundOptions

/Account/LoadInboundOptions

Load inbound options of your account

Parameters

ViewSettings

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey 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.elasticemail.com/v2/account/loadinboundoptions?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3

LoadPaymentHistory

/Account/LoadPaymentHistory

Lists all payments

Parameters

ViewBilling

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
fromDatedatetimeYesStarting date for search in YYYY-MM-DDThh:mm:ss format.
limitintYesMaximum number of returned items.
offsetintYesHow many items should be returned ahead.
toDatedatetimeYesEnding 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.elasticemail.com/v2/account/loadpaymenthistory?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey 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.elasticemail.com/v2/account/loadpayouthistory?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3

LoadReferralDetails

/Account/LoadReferralDetails

Shows information about your referral details

Parameters

ViewBilling

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey 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.elasticemail.com/v2/account/loadreferraldetails?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3

LoadReputationHistory

/Account/LoadReputationHistory

Shows latest changes in your sending reputation

Parameters

ViewAccount

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey 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.elasticemail.com/v2/account/loadreputationhistory?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3

LoadReputationImpact

/Account/LoadReputationImpact

Shows detailed information about your actual reputation score

Parameters

ViewAccount

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey 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.elasticemail.com/v2/account/loadreputationimpact?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3

LoadSpamCheck

/Account/LoadSpamCheck

Returns detailed spam check.

Parameters

ViewAccount

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
limitintNo20Maximum number of returned items.
offsetintNo0How 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.elasticemail.com/v2/account/loadspamcheck?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&limit=100&offset=20

LoadSubAccountsEmailCreditsHistory

/Account/LoadSubAccountsEmailCreditsHistory

Lists email credits history for sub-account

Parameters

ViewSubAccounts

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
publicAccountIDstringNonullPublic key of sub-account to list history for. Use subAccountEmail or publicAccountID not both.
subAccountEmailstringNonullEmail address of Sub-Account

Returns

{"success": true, "data": { List of EmailCredits } }

OR

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

Example copy link

https://api.elasticemail.com/v2/account/loadsubaccountsemailcreditshistory?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&subAccountEmail=mail@example.com&publicAccountID=

LoadSubAccountSettings

/Account/LoadSubAccountSettings

Loads settings of subaccount

Parameters

ViewSubAccounts

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
publicAccountIDstringNonullPublic key of sub-account to load settings for. Use subAccountEmail or publicAccountID not both.
subAccountEmailstringNonullEmail address of Sub-Account

Returns

{"success": true, "data": { SubAccountSettings } }

OR

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

Example copy link

https://api.elasticemail.com/v2/account/loadsubaccountsettings?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
fromdatetimeYesStarting date for search in YYYY-MM-DDThh:mm:ss format.
todatetimeYesEnding date for search in YYYY-MM-DDThh:mm:ss format.
loadSubaccountsUsagebooleanNotrue

Returns

{"success": true, "data": { List of Usage } }

OR

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

Example copy link

https://api.elasticemail.com/v2/account/loadusage?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
limitintNo0Maximum number of returned items.
offsetintNo0How 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.elasticemail.com/v2/account/loadwebhook?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&limit=100&offset=20

LoadWebNotificationOptions

/Account/LoadWebNotificationOptions

Load web notification options of your account

Parameters

ViewSettings

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey 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.elasticemail.com/v2/account/loadwebnotificationoptions?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3

Overview

/Account/Overview

Shows summary for your account.

Parameters

ViewAccount

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey 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.elasticemail.com/v2/account/overview?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3

ProfileOverview

/Account/ProfileOverview

Shows you account's profile basic overview

Parameters

ViewAccount

Access Level

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

Returns

{"success": true, "data": { Profile } }

OR

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

Example copy link

https://api.elasticemail.com/v2/account/profileoverview?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3

RemoveSubAccountCredits

/Account/RemoveSubAccountCredits

Remove email credits from a sub-account

Parameters

ModifySubAccounts

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
notesstringYesSpecific notes about the transaction
creditsintNonullAmount of credits to remove
publicAccountIDstringNonullPublic key of sub-account to remove credits from. Use subAccountEmail or publicAccountID not both.
removeAllbooleanNofalseRemove all credits of this type from sub-account (overrides credits if provided)
subAccountEmailstringNonullEmail address of Sub-Account

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/account/removesubaccountcredits?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&notes=&subAccountEmail=mail@example.com&publicAccountID=&credits=&removeAll=

RequestNewApiKey

/Account/RequestNewApiKey

Request a new default APIKey.

Parameters

Security

Access Level

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

Returns

{"success": true, "data": string }

OR

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

Example copy link

https://api.elasticemail.com/v2/account/requestnewapikey?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3

RequestPremiumSupport

/Account/RequestPremiumSupport

Request premium support for your account

Parameters

ModifyBilling

Access Level

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

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/account/requestpremiumsupport?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3

RequestPrivateIP

/Account/RequestPrivateIP

Request a private IP for your Account

Parameters

ModifySettings

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
countintYesNumber of items.
notesstringYesFree form field of notes

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/account/requestprivateip?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&count=100&notes=Contact is extremely important!

UpdateAdvancedOptions

/Account/UpdateAdvancedOptions

Update sending and tracking options of your account.

Parameters

ModifySettings

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
allowCustomHeadersbooleanNonullTrue, if you want to apply custom headers to your emails. Otherwise, false
autoTextFromHtmlbooleanNonullTrue, if text BODY of message should be created automatically. Otherwise, false
bccEmailstringNonullEmail address to send a copy of all email to.
consentTrackingOnUnsubscribebooleanNonull
contentTransferEncodingstringNonullType of content encoding
deliveryReasonstringNonullWhy your clients are receiving your emails.
emailNotificationEmailstringNonullSpecific email address to send bounce email notifications to.
emailNotificationForErrorbooleanNonullTrue, if you want bounce notifications returned. Otherwise, false
enableClickTrackingbooleanNonullTrue, if you want to track clicks. Otherwise, false
enableLinkClickTrackingbooleanNonullTrue, if you want to track by link tracking. Otherwise, false
enableOpenTrackingbooleanNonullTrue, if you want to track opens. Otherwise, false
enableTemplateScriptingbooleanNotrueTrue, if you want to use template scripting in your emails {{}}. Otherwise, false
enableUITooltipsbooleanNonullTrue, if Account has tooltips active. Otherwise, false
logoUrlstringNonullURL to your logo image.
lowCreditNotificationbooleanNonullTrue, if you want to receive low credit email notifications. Otherwise, false
manageSubscribedOnlybooleanNonullTrue, if you want to only display labels that the contact is subscribed to on your unsubscribe form. Otherwise, false
manageSubscriptionsbooleanNonullTrue, if you want to display your labels on your unsubscribe form. Otherwise, false
notificationsEmailsstringNonullEmail addresses to send a copy of all notifications from our system. Separated by semicolon
skipListUnsubscribebooleanNonullTrue, if you do not want to use list-unsubscribe headers. Otherwise, false
staleContactInactiveDaysintNonull(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
staleContactScoreintNonull(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
transactionalOnUnsubscribebooleanNonullTrue, if you want to display an option for the contact to opt into transactional email only on your unsubscribe form. Otherwise, false
tutorialsEnabledbooleanNonullTrue, if you want to enable Dashboard Tutotials
unsubscribeNotificationsEmailsstringNonullEmails, 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.elasticemail.com/v2/account/updateadvancedoptions?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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 Elastic Email under your brand.

Parameters

ModifySettings

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
customBouncesDomainstringNonull
enablePrivateBrandingbooleanNofalseTrue: Turn on or off ability to send mails under your brand. Otherwise, false
logoUrlstringNonullURL to your logo image.
paymentUrlstringNonullURL for making payments.
privateBrandingUrlstringNonullSubdomain for your rebranded service
smtpAddressstringNonullAddress of SMTP server.
smtpAlternativestringNonullAddress of alternative SMTP server.
supportLinkstringNonullAddress to your support.

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/account/updatecustombranding?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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=

UpdateInboundNotifications

/Account/UpdateInboundNotifications

Update inbound notifications options of your account.

Parameters

ModifyWebNotifications

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
hubCallBackUrlstringNo""URL used for tracking action of inbound emails
inboundContactsOnlybooleanNonullTrue, if you want inbound email to only process contacts from your Account. Otherwise, false
inboundDomainstringNonullDomain you use as your inbound domain

Returns

{"success": true, "data": { InboundOptions } }

OR

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

Example copy link

https://api.elasticemail.com/v2/account/updateinboundnotifications?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&inboundContactsOnly=true&hubCallBackUrl=http://&inboundDomain=yourdomain.com

UpdateProfile

/Account/UpdateProfile

Update your profile.

Parameters

ModifyProfile

Access Level

Name Type Required? Default value Description
address1stringYesFirst line of address.
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
citystringYesCity.
countryIDintYesNumeric ID of country. A file with the list of countries is available here
firstNamestringYesFirst name.
lastNamestringYesLast name.
statestringYesState or province.
zipstringYesZip/postal code.
address2stringNonullSecond line of address.
companystringNonullCompany name.
logoUrlstringNonullURL to your logo image.
marketingConsentbooleanNonullTrue if you want to receive newsletters from Elastic Email. Otherwise, false. Empty to leave the current value.
phonestringNonullPhone number
taxCodestringNonullCode used for tax purposes.
websitestringNonullHTTP address of your website.

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/account/updateprofile?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
allow2fabooleanNonullTrue, if you want to allow two-factor authentication. Otherwise, false.
dailySendLimitintNonullAmount of emails Account can send daily
emailSizeLimitintNo10Maximum size of email including attachments in MB's
enableContactFeaturesbooleanNonullTrue, if you want to use Contact Delivery Tools. Otherwise, false
enablePrivateIPRequestbooleanNofalseTrue, if Account can request for private IP on its own. Otherwise, false
maxContactsintNo0Maximum number of contacts the Account can have
monthlyRefillCreditsintNo0Amount of credits added to Account automatically
poolNamestringNonullName of your custom IP Pool to be used in the sending process
publicAccountIDstringNonullPublic key of sub-account to update. Use subAccountEmail or publicAccountID not both.
requiresEmailCreditsbooleanNofalseTrue, if Account needs credits to send emails. Otherwise, false
sendingPermissionSendingPermissionNonullSending permission setting for Account
subAccountEmailstringNonullEmail address of Sub-Account

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/account/updatesubaccountsettings?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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

UpdateWebhook

/Account/UpdateWebhook

Update notification webhook

Parameters

ModifyWebNotifications

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
webhookIDstringYes
namestringNonullFilename
notificationForAbuseReportbooleanNonull
notificationForClickedbooleanNonull
notificationForErrorbooleanNonull
notificationForOpenedbooleanNonull
notificationForSentbooleanNonull
notificationForUnsubscribedbooleanNonull
notifyOncePerEmailbooleanNonull
webNotificationUrlstringNonullURL 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.elasticemail.com/v2/account/updatewebhook?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&webhookID=&name=attachment.txt&webNotificationUrl=http://&notifyOncePerEmail=&notificationForSent=&notificationForOpened=&notificationForClicked=&notificationForUnsubscribed=&notificationForAbuseReport=&notificationForError=

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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
campaignCampaignYesJSON representation of a campaign

Returns

{"success": true, "data": Channel ID }

OR

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

Example copy link

https://api.elasticemail.com/v2/campaign/add?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
channelIDintYesID number of selected Channel.
newCampaignNamestringNonull

Returns

{"success": true, "data": Newly created Campaign's ChannelID }

OR

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

Example copy link

https://api.elasticemail.com/v2/campaign/copy?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
channelIDintYesID number of selected Channel.

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/campaign/delete?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&channelID=123456

Export

/Campaign/Export

Export Campaign data to the chosen file format.

Parameters

Export

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
channelIDsList of intNonullList of campaign IDs used for processing
compressionFormatCompressionFormatNoApiTypes.CompressionFormat.NoneFileResponse compression format. None or Zip.
fileFormatExportFileFormatsNoApiTypes.ExportFileFormats.CsvFormat of the exported file
fileNamestringNonullName of your file including extension.

Returns

{"success": true, "data": { ExportLink } }

OR

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

Example copy link

https://api.elasticemail.com/v2/campaign/export?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
limitintNo0Maximum number of returned items.
offsetintNo0How many items should be returned ahead.
searchstringNonullText fragment used for searching.

Returns

{"success": true, "data": { List of CampaignChannel } }

OR

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

Example copy link

https://api.elasticemail.com/v2/campaign/list?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&search=text&offset=20&limit=100

Update

/Campaign/Update

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

Parameters

ModifyCampaigns

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
campaignCampaignYesJSON representation of a campaign

Returns

{"success": true, "data": Channel ID }

OR

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

Example copy link

https://api.elasticemail.com/v2/campaign/update?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
namestringYesDescriptive name of the channel.

Returns

{"success": true, "data": Channel Name }

OR

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

Example copy link

https://api.elasticemail.com/v2/channel/add?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&name=

Delete

/Channel/Delete

Delete the selected Channel.

Parameters

ModifyChannels

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
namestringYesThe name of the Channel to delete.

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/channel/delete?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&name=

Export

/Channel/Export

Export selected Channels to chosen file format.

Parameters

Export

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
channelNamesList of stringYesList of channel names used for processing
compressionFormatCompressionFormatNoApiTypes.CompressionFormat.NoneFileResponse compression format. None or Zip.
fileFormatExportFileFormatsNoApiTypes.ExportFileFormats.CsvFormat of the exported file
fileNamestringNonullName of your file including extension.

Returns

{"success": true, "data": { ExportLink } }

OR

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

Example copy link

https://api.elasticemail.com/v2/channel/export?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&channelNames=Channel1,Channel2&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
limitintNo0Maximum number of returned items.
offsetintNo0How many items should be returned ahead.

Returns

{"success": true, "data": { List of Channel } }

OR

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

Example copy link

https://api.elasticemail.com/v2/channel/list?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&limit=100&offset=20

Update

/Channel/Update

Rename an existing Channel.

Parameters

ModifyChannels

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
namestringYesThe name of the Channel to update.
newNamestringYesThe new name for the Channel.

Returns

{"success": true, "data": Channel Name }

OR

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

Example copy link

https://api.elasticemail.com/v2/channel/update?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
emailstringYesProper email address.
publicAccountIDstringYes
activationReturnUrlstringNonullThe url to return the contact to after activation.
activationTemplatestringNonullCustom template to use for sending double opt-in activation emails.
alreadyActiveUrlstringNonullUrl to navigate to if contact already is subscribed
consentDatedatetimeNonullDate of consent to send this contact(s) your email. If not provided current date is used for consent.
consentIPstringNonullIP address of consent to send this contact(s) your email. If not provided your current public IP address is used for consent.
consentTrackingConsentTrackingNoApiTypes.ConsentTracking.Unknown
fieldRepeated list of string keys and string valuesNonullCustom contact field like companyname, customernumber, city etc. Request parameters prefixed by field_ like field_companyname, field_customernumber, field_city
firstNamestringNonullFirst name.
lastNamestringNonullLast name.
listNameList of stringNonullName of your list.
notifyEmailstringNonullEmails, separated by semicolon, to which the notification about contact subscribing should be sent to
publicListIDList of stringNonullID code of list
returnUrlstringNonullURL to navigate to after Account creation
sendActivationbooleanNotrueTrue, if you want to send activation email to this contact. Otherwise, false
sourceContactSourceNoApiTypes.ContactSource.ContactApiSpecifies the way of uploading the contact
sourceUrlstringNonullURL 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.elasticemail.com/v2/contact/add?publicAccountID=&email=mail@example.com&publicListID=public-id-of-your-list&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=

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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
emailstringYesProper email address.
statusContactStatusYesStatus of the given resource

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/contact/addblocked?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
emailstringYesProper email address.
namestringYesName of the contact property you want to change.
valuestringYesValue 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.elasticemail.com/v2/contact/changeproperty?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
statusContactStatusYesStatus of the given resource
emailsList of stringNonullComma delimited list of contact emails
rulestringNonullQuery used for filtering.

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/contact/changestatus?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&status=1&rule=Status%20=%20Engaged&emails=mail@contact.com,mail1@contact.com,mail2@contact.com

CountByStatus

/Contact/CountByStatus

Returns number of Contacts, RULE specifies contact Status.

Parameters

ViewContacts

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
rulestringNonullQuery used for filtering.

Returns

{"success": true, "data": { ContactStatusCounts } }

OR

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

Example copy link

https://api.elasticemail.com/v2/contact/countbystatus?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
fromdatetimeNonullStarting date for search in YYYY-MM-DDThh:mm:ss format.
todatetimeNonullEnding 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.elasticemail.com/v2/contact/countbyunsubscribereason?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&from=2001-01-01T01:01:01&to=2001-01-01T01:01:01

Delete

/Contact/Delete

Permanantly 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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
emailsList of stringNonullComma delimited list of contact emails
rulestringNonullQuery used for filtering.

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/contact/delete?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&rule=Status%20=%20Engaged&emails=mail@contact.com,mail1@contact.com,mail2@contact.com

Export

/Contact/Export

Export selected Contacts to file.

Parameters

Export

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
compressionFormatCompressionFormatNoApiTypes.CompressionFormat.NoneFileResponse compression format. None or Zip.
emailsList of stringNonullComma delimited list of contact emails
fileFormatExportFileFormatsNoApiTypes.ExportFileFormats.CsvFormat of the exported file
fileNamestringNonullName of your file including extension.
rulestringNonullQuery used for filtering.

Returns

{"success": true, "data": { ExportLink } }

OR

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

Example copy link

https://api.elasticemail.com/v2/contact/export?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
compressionFormatCompressionFormatNoApiTypes.CompressionFormat.NoneFileResponse compression format. None or Zip.
fileFormatExportFileFormatsNoApiTypes.ExportFileFormats.CsvFormat of the exported file
fileNamestringNonullName of your file including extension.
fromdatetimeNonullStarting date for search in YYYY-MM-DDThh:mm:ss format.
todatetimeNonullEnding 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.elasticemail.com/v2/contact/exportunsubscribereasoncount?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
emailstringYesProper email address.

Returns

{"success": true, "data": { ContactCollection } }

OR

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

Example copy link

https://api.elasticemail.com/v2/contact/findcontact?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&email=mail@example.com

GetContactsByList

/Contact/GetContactsByList

List of Contacts for provided List

Parameters

ViewContacts

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
listNamestringYesName of your list.
limitintNo20Maximum number of returned items.
offsetintNo0How 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.elasticemail.com/v2/contact/getcontactsbylist?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
segmentNamestringYesName of your segment.
limitintNo20Maximum number of returned items.
offsetintNo0How 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.elasticemail.com/v2/contact/getcontactsbysegment?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
limitintNo20Maximum number of returned items.
offsetintNo0How many items should be returned ahead.
rulestringNonullQuery used for filtering.
sortContactSortNonull

Returns

{"success": true, "data": { List of Contact } }

OR

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

Example copy link

https://api.elasticemail.com/v2/contact/list?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
statusesList of ContactStatusYesList of blocked statuses: Abuse, Bounced or Unsubscribed
limitintNo0Maximum number of returned items.
offsetintNo0How many items should be returned ahead.
searchstringNonullText fragment used for searching.

Returns

{"success": true, "data": { List of BlockedContact } }

OR

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

Example copy link

https://api.elasticemail.com/v2/contact/loadblocked?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&statuses=&search=text&limit=100&offset=20

LoadContact

/Contact/LoadContact

Load detailed contact information

Parameters

ViewContacts

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
emailstringYesProper email address.

Returns

{"success": true, "data": { Contact } }

OR

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

Example copy link

https://api.elasticemail.com/v2/contact/loadcontact?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&email=mail@example.com

LoadHistory

/Contact/LoadHistory

Shows detailed history of chosen Contact.

Parameters

ViewContacts

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
emailstringYesProper email address.
limitintNo0Maximum number of returned items.
offsetintNo0How many items should be returned ahead.

Returns

{"success": true, "data": { List of ContactHistory } }

OR

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

Example copy link

https://api.elasticemail.com/v2/contact/loadhistory?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&email=mail@example.com&limit=100&offset=20

QuickAdd

/Contact/QuickAdd

Add new Contact to one of your Lists.

Parameters

ModifyContacts

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
emailsList of stringYesComma delimited list of contact emails
consentDatedatetimeNonullDate of consent to send this contact(s) your email. If not provided current date is used for consent.
consentIPstringNonullIP address of consent to send this contact(s) your email. If not provided your current public IP address is used for consent.
consentTrackingConsentTrackingNoApiTypes.ConsentTracking.Unknown
fieldRepeated list of string keys and string valuesNonullCustom contact field like companyname, customernumber, city etc. Request parameters prefixed by field_ like field_companyname, field_customernumber, field_city
firstNamestringNonullFirst name.
lastNamestringNonullLast name.
listNamestringNonullName of your list.
notesstringNonullFree form field of notes
notifyEmailstringNonullEmails, separated by semicolon, to which the notification about contact subscribing should be sent to
publicListIDstringNonullID code of list
sourceContactSourceNoApiTypes.ContactSource.ManualInputSpecifies the way of uploading the contact
statusContactStatusNoApiTypes.ContactStatus.ActiveStatus of the given resource

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/contact/quickadd?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&emails=mail@contact.com,mail1@contact.com,mail2@contact.com&firstName=Fred&lastName=Flintstone&publicListID=public-id-of-your-list&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=&source=

Subscribe

/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
publicAccountIDstringYes

Returns

Redirection to the Subscription Confirmation Form

OR

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

Example copy link

https://api.elasticemail.com/v2/contact/subscribe?publicAccountID=

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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
emailstringYesProper email address.
clearRestOfFieldsbooleanNotrueStates if the fields that were omitted in this request are to be reset or should they be left with their current value
customFieldsstringNonullCustom contact field like companyname, customernumber, city etc. JSON serialized text like { "city":"london" }
fieldRepeated list of string keys and string valuesNonullCustom contact field like companyname, customernumber, city etc. Request parameters prefixed by field_ like field_companyname, field_customernumber, field_city
firstNamestringNonullFirst name.
lastNamestringNonullLast name.

Returns

{"success": true, "data": { Contact } }

OR

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

Example copy link

https://api.elasticemail.com/v2/contact/update?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
allowUnsubscribebooleanNofalseTrue: Allow unsubscribing from this (optional) newly created list. Otherwise, false
consentDatedatetimeNonullDate of consent to send this contact(s) your email. If not provided current date is used for consent.
consentIPstringNonullIP address of consent to send this contact(s) your email. If not provided your current public IP address is used for consent.
consentTrackingConsentTrackingNoApiTypes.ConsentTracking.Unknown
listIDintNonullID number of selected list.
listNamestringNonullName of your list to upload contacts to, or how the new, automatically created list should be named
statusContactStatusNoApiTypes.ContactStatus.ActiveStatus 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.elasticemail.com/v2/contact/upload?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&allowUnsubscribe=&listID=1234&listName=&status=1&consentDate=1/1/2015 0:00:00 AM&consentIP=192.168.0.1&consentTracking=

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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
domainstringYesName of selected domain.
setAsDefaultbooleanNofalseSet this domain as the default domain for the Account.
trackingTypeTrackingTypeNoApiTypes.TrackingType.Http

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/domain/add?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&domain=example.com&trackingType=&setAsDefault=

Delete

/Domain/Delete

Deletes a domain from the Account.

Parameters

ModifySettings

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
domainstringYesName of selected domain.

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/domain/delete?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&domain=example.com

List

/Domain/List

Lists all the domains configured for this Account.

Parameters

ViewSettings

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey 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.elasticemail.com/v2/domain/list?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3

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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
emailstringYesEmail 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.elasticemail.com/v2/domain/setdefault?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
domainstringYesName of selected domain.
isVerpbooleanYes
customBouncesDomainstringNonull
isCustomBouncesDomainDefaultbooleanNofalse

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/domain/setverp?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
domainstringYesDomain name to verify.

Returns

{"success": true, "data": string }

OR

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

Example copy link

https://api.elasticemail.com/v2/domain/verifydkim?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&domain=

VerifyMX

/Domain/VerifyMX

Verifies proper MX DNS configuration for the domain.

Parameters

ModifySettings

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
domainstringYesDomain name to verify.

Returns

{"success": true, "data": string }

OR

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

Example copy link

https://api.elasticemail.com/v2/domain/verifymx?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&domain=

VerifySpf

/Domain/VerifySpf

Verifies proper SPF DNS configuration for the domain.

Parameters

ModifySettings

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
domainstringYesDomain name to verifiy.

Returns

{"success": true, "data": { ValidationStatus } }

OR

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

Example copy link

https://api.elasticemail.com/v2/domain/verifyspf?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&domain=

VerifyTracking

/Domain/VerifyTracking

Verifies proper CNAME DNS configuration for the tracking domain.

Parameters

ModifySettings

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
domainstringYesDomain name to verify.
trackingTypeTrackingTypeNoApiTypes.TrackingType.Http

Returns

{"success": true, "data": string }

OR

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

Example copy link

https://api.elasticemail.com/v2/domain/verifytracking?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
transactionIDstringYesTransaction identifier
showAbusebooleanNofalseInclude Reported as abuse email addresses.
showClickedbooleanNofalseInclude Clicked email addresses.
showDeliveredbooleanNofalseInclude all delivered email addresses.
showErrorsbooleanNofalseInclude error messages for bounced emails.
showFailedbooleanNofalseInclude Bounced email addresses.
showMessageIDsbooleanNofalseInclude all MessageIDs for this transaction
showOpenedbooleanNofalseInclude Opened email addresses.
showPendingbooleanNofalseInclude Ready to send email addresses.
showSentbooleanNofalseInclude Sent email addresses.
showUnsubscribedbooleanNofalseInclude Unsubscribed email addresses.

Returns

{"success": true, "data": { EmailJobStatus } }

OR

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

Example copy link

https://api.elasticemail.com/v2/email/getstatus?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
msgIDstringYesID number of selected message.

Returns

{"success": true, "data": { List of File } }

OR

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

Example copy link

https://api.elasticemail.com/v2/email/listattachments?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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 included. For suggested implementations please refer to https://elasticemail.com/support/http-api/

Parameters

SendHttp

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
attachmentsList of stringNonullNames or IDs of attachments previously uploaded to your account (via the File/Upload request) that should be sent with this e-mail.
bodyAmpstringNonullAMP email body
bodyHtmlstringNonullHtml email body
bodyTextstringNonullText email body
channelstringNonullAn ID field (max 191 chars) that can be used for reporting [will default to HTTP API or SMTP API]
charsetstringNonullText value of charset encoding for example: iso-8859-1, windows-1251, utf-8, us-ascii, windows-1250 and moreā€¦
charsetBodyAmpstringNonullSets charset for body AMP MIME part (overrides default value from charset parameter)
charsetBodyHtmlstringNonullSets charset for body html MIME part (overrides default value from charset parameter)
charsetBodyTextstringNonullSets charset for body text MIME part (overrides default value from charset parameter)
dataSourcestringNonullName or ID of the previously uploaded file (via the File/Upload request) which should be a CSV list of Recipients.
encodingTypeEncodingTypeNoApiTypes.EncodingType.None0 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.
fromstringNonullFrom email address
fromNamestringNonullDisplay name for from email address
headersRepeated list of string keys and string valuesNonullOptional 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
isTransactionalbooleanNofalseTrue, if email is transactional (non-bulk, non-marketing, non-commercial). Otherwise, false
listsList of stringNonullThe name of a contact list you would like to send to. Separate multiple contact lists by commas or semicolons.
mergeRepeated list of string keys and string valuesNonullRequest 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.
mergeSourceFilenamestringNonullFile name one of attachments which is a CSV list of Recipients.
msgBccList of stringNonullOptional 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.
msgCCList of stringNonullOptional 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.
msgFromstringNonullOptional parameter. Sets FROM MIME header.
msgFromNamestringNonullOptional parameter. Sets FROM name of MIME header.
msgToList of stringNonullOptional 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.
poolNamestringNonullName of your custom IP Pool to be used in the sending process
postBackstringNonullOptional header returned in notifications.
replyTostringNonullEmail address to reply to
replyToNamestringNonullDisplay name of the reply to address
segmentsList of stringNonullThe name of a segment you would like to send to. Separate multiple segments by comma or semicolon. Insert "0" for all Active contacts.
senderstringNonullEmail address of the sender
senderNamestringNonullDisplay name sender
subjectstringNonullEmail subject
templatestringNonullThe ID of an email template you have created in your account.
timeOffSetMinutesstringNonullNumber of minutes in the future this email should be sent up to a maximum of 1 year (524160 minutes)
toList of stringNonullList 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.
trackClicksbooleanNonullShould the clicks be tracked? If no value has been provided, Account's default setting will be used.
trackOpensbooleanNonullShould the opens be tracked? If no value has been provided, Account's default setting will be used.
utmCampaignstringNonullThe utm_campaign marketing parameter appended to each link in the campaign.
utmContentstringNonullThe utm_content marketing parameter appended to each link in the campaign.
utmMediumstringNonullThe utm_medium marketing parameter appended to each link in the campaign.
utmSourcestringNonullThe 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.elasticemail.com/v2/email/send?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
messageIDstringYesUnique identifier for this email.

Returns

{"success": true, "data": { EmailStatus } }

OR

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

Example copy link

https://api.elasticemail.com/v2/email/status?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&messageID=-HHGPM_9RPhSMiaJq_ab4g3

VerificationResult

/Email/VerificationResult

Checks if verification emails is completed.

Parameters

VerifyEmails

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
txIDGUIDYes

Returns

{"success": true, "data": { Export } }

OR

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

Example copy link

https://api.elasticemail.com/v2/email/verificationresult?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&txID=

Verify

/Email/Verify

Verify single email address

Parameters

VerifyEmails

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
emailstringYesProper email address.
uploadContactbooleanNofalse

Returns

{"success": true, "data": { EmailValidationResult } }

OR

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

Example copy link

https://api.elasticemail.com/v2/email/verify?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&email=mail@example.com&uploadContact=

VerifyList

/Email/VerifyList

Verify list of email addresses from file. Each email has to be in 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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
listnameToVerifystringNonull
uploadContactsbooleanNofalse

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.elasticemail.com/v2/email/verifylist?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&listnameToVerify=&uploadContacts=

View

/Email/View

View email

Parameters

Name Type Required? Default value Description
messageIDstringYesMessage identifier
enableTrackingbooleanNofalse

Returns

{"success": true, "data": { EmailView } }

OR

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

Example copy link

https://api.elasticemail.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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
publicExportIDGUIDYesID of the exported file

Returns

{"success": true, "data": { ExportStatus } }

OR

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

Example copy link

https://api.elasticemail.com/v2/export/checkstatus?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&publicExportID=123456

Delete

/Export/Delete

Delete the specified export.

Parameters

Export

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
publicExportIDGUIDYesID of the exported file

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/export/delete?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&publicExportID=123456

DownloadBulk

/Export/DownloadBulk

Download the specified export files in one package

Parameters

Export

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
publicExportIDsList of GUIDYes

Returns

Output stream containing file data

OR

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

Example copy link

https://api.elasticemail.com/v2/export/downloadbulk?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&publicExportIDs=

List

/Export/List

Returns a list of all exported data.

Parameters

Export

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
limitintNo0Maximum number of returned items.
offsetintNo0How 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.elasticemail.com/v2/export/list?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
fileIDintNonullUnique identifier for the file stored in your Account.
filenamestringNonullName of your file including extension.

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/file/delete?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
fileIDintNonullUnique identifier for the file stored in your Account.
filenamestringNonullName of your file including extension.

Returns

Output stream containing file data

OR

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

Example copy link

https://api.elasticemail.com/v2/file/download?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&filename=filename.txt&fileID=123456

ListAll

/File/ListAll

Lists all your available files.

Parameters

ViewFiles

Access Level

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

Returns

{"success": true, "data": { List of File } }

OR

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

Example copy link

https://api.elasticemail.com/v2/file/listall?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3

Load

/File/Load

Returns detailed file information for the given file.

Parameters

ViewFiles

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
filenamestringYesName of your file including extension.

Returns

{"success": true, "data": { File } }

OR

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

Example copy link

https://api.elasticemail.com/v2/file/load?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
enforceUniqueFileNamebooleanNofalseIf a file exists with the same name do not upload and override the file.
expiresAfterDaysintNo35Number of days the file should be stored for.
namestringNonullFilename

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.elasticemail.com/v2/file/upload?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
listNamestringYesName of your list.
allContactsbooleanNofalseTrue: Include every Contact in your Account. Otherwise, false
allowUnsubscribebooleanNofalseTrue: Allow unsubscribing from this list. Otherwise, false
createEmptyListbooleanNofalseTrue to create an empty list, otherwise false. Ignores rule and emails parameters if provided.
emailsList of stringNonullComma delimited list of contact emails
rulestringNonullQuery used for filtering.

Returns

{"success": true, "data": List ID }

OR

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

Example copy link

https://api.elasticemail.com/v2/list/add?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
listNamestringYesName of your list.
allContactsbooleanNofalseTrue: Include every Contact in your Account. Otherwise, false
emailsList of stringNonullComma delimited list of contact emails
rulestringNonullQuery used for filtering.

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/list/addcontacts?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&listName=My List 1&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
sourceListNamestringYesThe name of the list you want to copy
allowUnsubscribebooleanNonullTrue: Allow unsubscribing from this list. Otherwise, false
createEmptyListbooleanNonullTrue to create an empty list, otherwise false. Ignores rule and emails parameters if provided.
newlistNamestringNonullName of your list if you want to change it.
rulestringNonullQuery used for filtering.

Returns

{"success": true, "data": New list's ID }

OR

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

Example copy link

https://api.elasticemail.com/v2/list/copy?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&sourceListName=&newlistName=My List 2&createEmptyList=true/false&allowUnsubscribe=true/false&rule=Status%20=%20Engaged

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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
campaignIDintYesID of the campaign which recipients you want to copy
listNamestringYesName of your list.
statusesList of LogJobStatusNonullStatuses 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.elasticemail.com/v2/list/createfromcampaign?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&campaignID=&listName=My List 1&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
listNamestringYesName of your list.
numberOfListsintYesThe number of evenly distributed lists to create.
allContactsbooleanNofalseTrue: Include every Contact in your Account. Otherwise, false
allowUnsubscribebooleanNofalseTrue: Allow unsubscribing from this list. Otherwise, false
excludeBlockedbooleanNotrueTrue if you want to exclude contacts that are currently in a blocked status of either unsubscribe, complaint or bounce. Otherwise, false.
rulestringNonullQuery used for filtering.

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/list/createnthselectionlists?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
countintYesNumber of items.
listNamestringYesName of your list.
allContactsbooleanNofalseTrue: Include every Contact in your Account. Otherwise, false
allowUnsubscribebooleanNofalseTrue: Allow unsubscribing from this list. Otherwise, false
excludeBlockedbooleanNotrueTrue if you want to exclude contacts that are currently in a blocked status of either unsubscribe, complaint or bounce. Otherwise, false.
rulestringNonullQuery used for filtering.

Returns

{"success": true, "data": List ID }

OR

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

Example copy link

https://api.elasticemail.com/v2/list/createrandomlist?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
listNamestringYesName of your list.

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/list/delete?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&listName=My List 1

Export

/List/Export

Exports all the contacts from the provided list

Parameters

Export

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
listNamestringYesName of your list.
compressionFormatCompressionFormatNoApiTypes.CompressionFormat.NoneFileResponse compression format. None or Zip.
fileFormatExportFileFormatsNoApiTypes.ExportFileFormats.CsvFormat of the exported file
fileNamestringNonullName of your file including extension.

Returns

{"success": true, "data": { ExportLink } }

OR

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

Example copy link

https://api.elasticemail.com/v2/list/export?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&listName=My List 1&fileFormat=Csv&compressionFormat=Zip&fileName=filename.txt

list

/List/list

Shows all your existing lists

Parameters

ViewContacts

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
fromdatetimeNonullStarting date for search in YYYY-MM-DDThh:mm:ss format.
todatetimeNonullEnding 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.elasticemail.com/v2/list/list?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
listNamestringYesName of your list.

Returns

{"success": true, "data": { List } }

OR

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

Example copy link

https://api.elasticemail.com/v2/list/load?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&listName=My List 1

MoveContacts

/List/MoveContacts

Move selected contacts from one List to another

Parameters

ModifyContacts

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
newListNamestringYesThe name of the list to copy the contacts to
oldListNamestringYesThe name of the list from which the contacts will be copied from
emailsList of stringNonullComma delimited list of contact emails
moveAllbooleanNonullTRUE - moves all contacts; FALSE - moves contacts provided in the 'emails' parameter. This is ignored if the 'statuses' parameter has been provided
rulestringNonullQuery used for filtering.
statusesList of ContactStatusNonullList 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.elasticemail.com/v2/list/movecontacts?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
listNamestringYesName of your list.
emailsList of stringNonullComma delimited list of contact emails
rulestringNonullQuery used for filtering.

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/list/removecontacts?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&listName=My List 1&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
listNamestringYesName of your list.
allowUnsubscribebooleanNofalseTrue: Allow unsubscribing from this list. Otherwise, false
newListNamestringNonullName of your list if you want to change it.

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/list/update?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&listName=My List 1&newListName=My List 2&allowUnsubscribe=true/false

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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
channelNamestringNonullName of selected channel.
transactionIDstringNonullID number of transaction

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/log/cancelinprogress?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
channelNamestringNonullName of selected channel.
fromdatetimeNonullStarting date for search in YYYY-MM-DDThh:mm:ss format.
limitintNo0Maximum number of returned items.
offsetintNo0How many items should be returned ahead.
statusesList of LogEventStatusNonullList 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
todatetimeNonullEnding 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.elasticemail.com/v2/log/events?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
statusesList of LogJobStatusYesList 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
channelNamestringNonullName of selected channel.
compressionFormatCompressionFormatNoApiTypes.CompressionFormat.NoneFileResponse compression format. None or Zip.
emailstringNonullProper email address.
fileFormatExportFileFormatsNoApiTypes.ExportFileFormats.CsvFormat of the exported file
fileNamestringNonullName of your file including extension.
fromdatetimeNonullStart date.
includeEmailbooleanNotrueTrue: Search includes emails. Otherwise, false.
includeSmsbooleanNotrueTrue: Search includes SMS. Otherwise, false.
messageCategoryList of MessageCategoryNonullID of message category
todatetimeNonullEnd date.

Returns

{"success": true, "data": { ExportLink } }

OR

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

Example copy link

https://api.elasticemail.com/v2/log/export?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
channelNamestringNonullName of selected channel.
compressionFormatCompressionFormatNoApiTypes.CompressionFormat.NoneFileResponse compression format. None or Zip.
fileFormatExportFileFormatsNoApiTypes.ExportFileFormats.CsvFormat of the exported file
fileNamestringNonullName of your file including extension.
fromdatetimeNonullStarting date for search in YYYY-MM-DDThh:mm:ss format.
statusesList of LogEventStatusNonullList 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
todatetimeNonullEnding 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.elasticemail.com/v2/log/exportevents?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&statuses=0&from=2001-01-01T01:01:01&to=2001-01-01T01:01:01&channelName=Channel01&fileFormat=Csv&compressionFormat=Zip&fileName=filename.txt

ExportLinkTracking

/Log/ExportLinkTracking

Export detailed link tracking information to the specified file format.

Parameters

Export

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
fromdatetimeYesStarting date for search in YYYY-MM-DDThh:mm:ss format.
todatetimeYesEnding date for search in YYYY-MM-DDThh:mm:ss format.
channelNamestringNonullName of selected channel.
compressionFormatCompressionFormatNoApiTypes.CompressionFormat.NoneFileResponse compression format. None or Zip.
fileFormatExportFileFormatsNoApiTypes.ExportFileFormats.CsvFormat of the exported file
fileNamestringNonullName of your file including extension.
limitintNo0Maximum number of returned items.
offsetintNo0How many items should be returned ahead.

Returns

{"success": true, "data": { ExportLink } }

OR

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

Example copy link

https://api.elasticemail.com/v2/log/exportlinktracking?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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

LinkTracking

/Log/LinkTracking

Track link clicks

Parameters

ViewReports

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
channelNamestringNonullName of selected channel.
fromdatetimeNonullStarting date for search in YYYY-MM-DDThh:mm:ss format.
limitintNo0Maximum number of returned items.
offsetintNo0How many items should be returned ahead.
todatetimeNonullEnding 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.elasticemail.com/v2/log/linktracking?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&from=2001-01-01T01:01:01&to=2001-01-01T01:01:01&limit=100&offset=20&channelName=Channel01

Load

/Log/Load

Returns logs filtered by specified parameters.

Parameters

ViewReports

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
statusesList of LogJobStatusYesList 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
channelNamestringNonullName of selected channel.
emailstringNonullProper email address.
fromdatetimeNonullStarting date for search in YYYY-MM-DDThh:mm:ss format.
includeEmailbooleanNotrueTrue: Search includes emails. Otherwise, false.
includeSmsbooleanNotrueTrue: Search includes SMS. Otherwise, false.
ipaddressstringNonullSearch for recipients that we sent through this IP address
limitintNo0Maximum number of returned items.
messageCategoryList of MessageCategoryNonullID of message category
offsetintNo0How many items should be returned ahead.
todatetimeNonullEnding 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.elasticemail.com/v2/log/load?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
statusesList of LogJobStatusYesList 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
fromdatetimeNonullStarting date for search in YYYY-MM-DDThh:mm:ss format.
limitintNo0Maximum number of returned items.
messageCategoryList of MessageCategoryNonullID of message category
notificationTypeNotificationTypeNoApiTypes.NotificationType.All
offsetintNo0How many items should be returned ahead.
todatetimeNonullEnding date for search in YYYY-MM-DDThh:mm:ss format.
useStatusChangeDatebooleanNofalseTrue, 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.elasticemail.com/v2/log/loadnotifications?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&statuses=0&from=2001-01-01T01:01:01&to=2001-01-01T01:01:01&limit=100&offset=20&messageCategory=1&useStatusChangeDate=false&notificationType=

Summary

/Log/Summary

Loads summary information about activity in chosen date range.

Parameters

ViewReports

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
fromdatetimeYesStarting date for search in YYYY-MM-DDThh:mm:ss format.
todatetimeYesEnding date for search in YYYY-MM-DDThh:mm:ss format.
channelNamestringNonullName of selected channel.
intervalIntervalTypeNoApiTypes.IntervalType.Summary'Hourly' for detailed information, 'summary' for daily overview
transactionIDstringNonullID number of transaction

Returns

{"success": true, "data": { LogSummary } }

OR

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

Example copy link

https://api.elasticemail.com/v2/log/summary?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
rulestringYesQuery used for filtering.
segmentNamestringYesName of your segment.

Returns

{"success": true, "data": { Segment } }

OR

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

Example copy link

https://api.elasticemail.com/v2/segment/add?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
sourceSegmentNamestringYesThe name of the segment you want to copy
newSegmentNamestringNonullNew name of your segment if you want to change it.
rulestringNonullQuery used for filtering.

Returns

{"success": true, "data": { Segment } }

OR

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

Example copy link

https://api.elasticemail.com/v2/segment/copy?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
segmentNamestringYesName of your segment.

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/segment/delete?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
segmentNamestringYesName of your segment.
compressionFormatCompressionFormatNoApiTypes.CompressionFormat.NoneFileResponse compression format. None or Zip.
fileFormatExportFileFormatsNoApiTypes.ExportFileFormats.CsvFormat of the exported file
fileNamestringNonullName of your file including extension.

Returns

{"success": true, "data": { ExportLink } }

OR

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

Example copy link

https://api.elasticemail.com/v2/segment/export?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
fromdatetimeNonullFrom what date should the segment history be shown. In YYYY-MM-DDThh:mm:ss format.
includeHistorybooleanNofalseTrue: Include history of last 30 days. Otherwise, false.
todatetimeNonullTo 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.elasticemail.com/v2/segment/list?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
segmentNamesList of stringYesNames of segments you want to load. Will load all contacts if left empty or the 'All Contacts' name has been provided
fromdatetimeNonullFrom what date should the segment history be shown. In YYYY-MM-DDThh:mm:ss format.
includeHistorybooleanNofalseTrue: Include history of last 30 days. Otherwise, false.
todatetimeNonullTo 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.elasticemail.com/v2/segment/loadbyname?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&segmentNames=&includeHistory=true/false&from=&to=

Update

/Segment/Update

Rename or change RULE for your segment

Parameters

ModifyContacts

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
segmentNamestringYesName of your segment.
newSegmentNamestringNonullNew name of your segment if you want to change it.
rulestringNonullQuery used for filtering.

Returns

{"success": true, "data": { Segment } }

OR

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

Example copy link

https://api.elasticemail.com/v2/segment/update?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&segmentName=My Segment 1&newSegmentName=My Segment 2&rule=Status%20=%20Engaged

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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
bodystringYesBody 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
tostringYesMobile 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.elasticemail.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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
fromEmailstringYesDefault From: email address.
fromNamestringYesDefault From: name.
namestringYesFilename
subjectstringYesDefault subject of email.
bodyAmpstringNonullAMP code of email (needs escaping).
bodyHtmlstringNonullHTML code of email (needs escaping).
bodyTextstringNonullText body of email.
cssstringNonullCSS style
originalTemplateIDintNo0ID number of original template.
tagsList of stringNonull
templateScopeTemplateScopeNoApiTypes.TemplateScope.PrivateEnum: 0 - private, 1 - public, 2 - mockup

Returns

{"success": true, "data": Template ID }

OR

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

Example copy link

https://api.elasticemail.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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
tagstringYesTag's value

Returns

{"success": true, "data": { TemplateTag } }

OR

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

Example copy link

https://api.elasticemail.com/v2/template/addtag?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&tag=

Copy

/Template/Copy

Copy Selected Template

Parameters

ModifyTemplates

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
fromEmailstringYesDefault From: email address.
fromNamestringYesDefault From: name.
namestringYesFilename
subjectstringYesDefault subject of email.
templateIDintYesID number of template.

Returns

{"success": true, "data": { Template } }

OR

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

Example copy link

https://api.elasticemail.com/v2/template/copy?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
templateIDintYesID number of template.

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/template/delete?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&templateID=1234

DeleteBulk

/Template/DeleteBulk

Delete templates with the specified ID

Parameters

ModifyTemplates

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
templateIDsList of intYes

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/template/deletebulk?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&templateIDs=

DeleteTag

/Template/DeleteTag

Delete a tag, removing it from all Templates

Parameters

ModifyTemplates

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
tagstringYes

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/template/deletetag?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&tag=

GetList

/Template/GetList

Lists your templates, optionally searching by Tags

Parameters

ViewTemplates

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
limitintNo500If provided, returns templates with these tags
offsetintNo0Filters on template type
tagsList of stringNonull
templateTypesList of TemplateTypeNonull

Returns

{"success": true, "data": { TemplateList } }

OR

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

Example copy link

https://api.elasticemail.com/v2/template/getlist?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&tags=&templateTypes=&limit=&offset=

GetTagList

/Template/GetTagList

Retrieve a list of your Tags

Parameters

ViewTemplates

Access Level

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

Returns

{"success": true, "data": { TemplateTagList } }

OR

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

Example copy link

https://api.elasticemail.com/v2/template/gettaglist?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3

IsUsedByCampaign

/Template/IsUsedByCampaign

Check if template is used by campaign.

Parameters

ViewTemplates

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
templateIDintYesID 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.elasticemail.com/v2/template/isusedbycampaign?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&templateID=1234

LoadTemplate

/Template/LoadTemplate

Load template with content

Parameters

ViewTemplates

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
templateIDintYesID number of template.

Returns

{"success": true, "data": { Template } }

OR

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

Example copy link

https://api.elasticemail.com/v2/template/loadtemplate?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&templateID=1234

ReadRssFeed

/Template/ReadRssFeed

Read Rss feed

Parameters

ViewTemplates

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
urlstringYesRss feed url.
countintNo3Number of item tags to read.

Returns

{"success": true, "data": string }

OR

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

Example copy link

https://api.elasticemail.com/v2/template/readrssfeed?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
templateIDintYesID number of template.
bodyAmpstringNonullAMP code of email (needs escaping).
bodyHtmlstringNonullHTML code of email (needs escaping).
bodyTextstringNonullText body of email.
cssstringNonullCSS style
fromEmailstringNonullDefault From: email address.
fromNamestringNonullDefault From: name.
namestringNonullFilename
removeScreenshotbooleanNotrue
subjectstringNonullDefault subject of email.
tagsList of stringNonull
templateScopeTemplateScopeNoApiTypes.TemplateScope.PrivateEnum: 0 - private, 1 - public, 2 - mockup

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
templateIDsList of intYes
fromEmailstringNonullDefault From: email address.
fromNamestringNonullDefault From: name.
subjectstringNonullDefault subject of email.
templateScopeTemplateScopeNoApiTypes.TemplateScope.PrivateEnum: 0 - private, 1 - public, 2 - mockup

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/template/updatedefaultoptions?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
emailAddressstringYes
returnUrlstringNonullURL to navigate to after Account creation

Returns

{"success": true, "data": { ValidEmail } }

OR

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

Example copy link

https://api.elasticemail.com/v2/validemail/add?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&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
apikeystringYesApiKey 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.elasticemail.com/v2/validemail/list?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3

Remove

/ValidEmail/Remove

Delete valid email from account.

Parameters

ModifySettings

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
validEmailIDintYes

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/validemail/remove?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&validEmailID=

ResendEmailVerification

/ValidEmail/ResendEmailVerification

Resends email verification.

Parameters

ModifySettings

Access Level

Name Type Required? Default value Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's. Available here.
emailAddressstringYes
returnUrlstringNonullURL to navigate to after Account creation

Returns

{"success": true}

OR

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

Example copy link

https://api.elasticemail.com/v2/validemail/resendemailverification?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&emailAddress=&returnUrl=http://yourdomain.com

Classes
Classes used in Elastic Email API

AccessLevel Enumeration

NameValueDescription
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
Modify2FA 34359738368
ModifySupport 68719476736
ViewCustomFields 137438953472
ModifyCustomFields 274877906944
ModifyWebNotifications 549755813888
ExtendedLogs 1099511627776
VerifyEmails 2199023255552

AccessToken

PropertyTypeDescriptionExample
AccessLevel AccessLevelAccess level or permission to be assigned to this Access Token.
LastUse datetimeDate this AccessToken was last used.
Name stringFilenameattachment.txt

Account

Detailed information about your account

PropertyTypeDescriptionExample
AccountPaymentUrl stringURL for making payments.http://payments.yourdomain.com
Address1 stringFirst line of address.12 Granite Road
Address2 stringSecond line of address.Apartment B
AffiliateLink stringURL for affiliating.http://
ApiKey stringApiKey that gives you access to our SMTP and HTTP API's.94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3
AutoCreditAmount decimalWhen AutoCreditStatus is Enabled, the amount of credit to be recharged.500
AutoCreditLevel decimalWhen AutoCreditStatus is Enabled, the credit level that triggers the credit to be recharged.100
AutoCreditStatus stringStatus of automatic payments configuration.Off
City stringCity.Bedrock
Company stringCompany name.Slate
ContentTransferEncoding stringType of content encodingBase64
CountryID intNumeric ID of country. A file with the list of countries is available here12345
Credit decimalCurrent credit in Account for Pay as you go plans. 1000
DailySendLimit intAmount of emails Account can send daily100000
DateCreated datetimeCreation date.2001-01-01T12:00:00
DeliveryReason stringWhy your clients are receiving your emails.Reason
DisableGlobalContacts boolean
Email stringProper email address.mail@example.com
EmailCredits intAmount of email credits1000
EnableContactFeatures booleanEnable contact delivery and optimization tools on your Account.
EnablePrivateBranding booleanTrue: Turn on or off ability to send mails under your brand. Otherwise, falsetrue
FirstName stringFirst name.Fred
IsSub booleanTrue, if Account is a Sub-Account. Otherwise, falsefalse
IsUser boolean
LastName stringLast name.Flintstone
LinkTracking booleanTrue, if you have enabled link tracking. Otherwise, falsetrue
LogoUrl stringURL to your logo image.http://yourdomain.com/logo.png
MonthlyEmailsSent longAmount of emails sent from this Account1000
NeedsSMSVerification boolean
PaymentFormUrl stringURL form for payments.http://
Phone stringPhone number1234567890
PricePerEmail decimalAmount of emails sent from this Account1000
PrivateBrandingUrl stringSubdomain for your rebranded servicemailing.yourdomain.com
PublicAccountID string
Reputation doubleNumeric reputation100
Smtp stringAddress of SMTP server.smtp.yourdomain.com
SmtpAlternative stringAddress of alternative SMTP server.smtp2.yourdomain.com
State stringState or province.CA
StatusFormatted stringAccount status: ActiveActive
StatusNumber intNumber of status: 1 - Active1
SubAccountsCount longThe number of Sub-Accounts this Account has.1
SupportLink stringAddress to your support.http://help.yourdomain.com
TaxCode stringCode used for tax purposes.
TotalEmailsSent longAmount of emails sent from this Account1000
UntrustedDeviceAlertDisabled boolean
Website stringHTTP address of your website.http://example.com
Zip stringZip/postal code.00000

AccountOverview

Basic overview of your account

PropertyTypeDescriptionExample
BlockedContactsCount longNumber of contacts currently with blocked status of Unsubscribed, Complaint, Bounced or InActive1000
CampaignCount longNumber of created campaigns10
ContactCount longNumber of contacts10000
CostPerThousand decimalCost of 1000 emails0.09
Credit decimalCurrent credit in Account for Pay as you go plans. 1000
InProgressCount longNumber of messages in progress1234
ReferralCount longNumber of active referrals10
Reputation doubleNumeric reputation100
SubAccountCount longNumber of created Sub-Accounts10
TemplateCount longNumber of available templates10
TotalEmailsSent longAmount of emails sent from this Account1000

AdvancedOptions

Lists advanced sending options of your account.

PropertyTypeDescriptionExample
AllowCustomHeaders booleanTrue, if you want to apply custom headers to your emails. Otherwise, falsetrue
AutoTextFormat booleanTrue, if text BODY of message should be created automatically. Otherwise, falsetrue
BccEmail stringEmail address to send a copy of all email to.your@email.com
ConsentTrackingOnUnsubscribe boolean
ContentTransferEncoding stringType of content encodingBase64
DeliveryReason stringWhy your clients are receiving your emails.Reason
EmailNotification stringTrue, if you want to receive bounce email notifications. Otherwise, falsetrue
EmailNotificationForError booleanTrue, if you want bounce notifications returned. Otherwise, falsefalse
EnableClickTracking booleanTrue, if you want to track clicks. Otherwise, falsetrue
EnableContactFeatures booleanTrue, if you want to use Contact Delivery Tools. Otherwise, false
EnableLinkClickTracking booleanTrue, if you want to track by link tracking. Otherwise, falsetrue
EnableTemplateScripting booleanTrue, if you want to use template scripting in your emails {{}}. Otherwise, falsetrue
EnableUITooltips booleanTrue, if Account has tooltips active. Otherwise, falsetrue
EnableUnsubscribeHeader booleanTrue, if you want to enable list-unsubscribe header. Otherwise, falsetrue
IsOwnedByReseller booleanTrue, if this Account resells Elastic Email. Otherwise, false.false
IsSubAccount booleanTrue, if this Account is a Sub-Account. Otherwise, falsetrue
LogoUrl stringURL to your logo image.http://yourdomain.com/logo.png
LowCreditNotification booleanTrue, if you want to receive low credit email notifications. Otherwise, falsetrue
ManageSubscribedOnly booleanTrue, if you want to only display labels that the contact is subscribed to on your unsubscribe form. Otherwise, falsetrue
ManageSubscriptions booleanTrue, if you want to display your labels on your unsubscribe form. Otherwise, falsetrue
NotificationsEmails stringEmail addresses to send a copy of all notifications from our system. Separated by semicolonemail1@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 status180
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 booleanTrue, if you want to display an option for the contact to opt into transactional email only on your unsubscribe form. Otherwise, falsetrue
TutorialsEnabled booleanTrue, if you want to enable Dashboard Tutotialstrue
UnsubscribeNotificationEmails stringEmails, separated by semicolon, to which the notification about contact unsubscribing should be sent toemail1@example.com;email2@example.com

BlockedContact

Blocked Contact - Contact returning Hard Bounces

PropertyTypeDescriptionExample
DateUpdated stringLast change date2001-01-01T12:00:00
Email stringProper email address.mail@example.com
FriendlyErrorMessage stringRFC error messageMailbox not found
Status stringStatus of the given resource1

BouncedCategorySummary

Summary of bounced categories, based on specified date range.

PropertyTypeDescriptionExample
AccountProblem longNumber of messages flagged with 'Account Problem'0
BlackListed longNumber of blacklisted messages1000
CodeError longNumber of messages flagged with 'Code Error'0
ConnectionProblem longNumber of messages flagged with 'Connection Problem'0
ConnectionTerminated longNumber of messages flagged with 'Connection terminated'0
DnsProblem longNumber of messages flagged with 'DNS Problem'0
GreyListed longNumber of messages flagged with 'Grey Listed'0
ManualCancel longNumber of manually cancelled messages1000
NoMailbox longNumber of messages flagged with 'No Mailbox'0
NotDelivered longNumber of messages flagged with 'Not Delivered'0
Spam longNumber of messages marked as SPAM1000
SpfProblem longNumber of messages flagged with 'SPF Problem'0
Throttled longNumber of messages flagged with 'Throttled'0
Timeout longNumber of messages flagged with 'Timeout'0
WhitelistingProblem longNumber of messages flagged with 'WhiteListing Problem'0

Campaign

Campaign

PropertyTypeDescriptionExample
CampaignTemplates List of CampaignTemplate
ChannelID intID number of selected Channel.123456
Name stringCampaign's name
SplitOptimization SplitOptimizationWhat should be checked for choosing the winner: opens or clicks0
SplitOptimizationMinutes intNumber of minutes between sends during optimization period30
Status CampaignStatusName of campaign's status
Targets Repeated list of stringList of Segment and List IDs, preceded with 'l' for Lists and 's' for Segments, comma separateds01,l10
TimingOption int
TrackClicks booleanShould the clicks be tracked? If no value has been provided, Account's default setting will be used.true
TrackOpens booleanShould the opens be tracked? If no value has been provided, Account's default setting will be used.true
TriggerChannelID intWhich Channel's event should trigger this Campaign12345
TriggerChannelName string
TriggerCount intHow many times should the campaign be sent1
TriggerData stringData for filtering event campaigns such as specific link addresses.http://elasticemail.com
TriggerDate datetimeDate of triggered send2001-01-01T12:00:00
TriggerDelay doubleHow far into the future should the campaign be sent, in minutes20
TriggerFrequency doubleWhen your next automatic mail will be sent, in minutes30
TriggerType CampaignTriggerTypeNumber of event, triggering mail sending1

CampaignChannel

Channel

PropertyTypeDescriptionExample
ChannelID intID number of selected Channel.123456
ClickedCount intTotal emails clicked1000
DateAdded datetimeDate of creation in YYYY-MM-DDThh:ii:ss format2001-01-01T12:00:00
FailedAbuse intAbuses - mails sent to user without their consent0.00
FailedCount intTotal emails failed.1000
IsCampaign booleanTrue, if you are sending a campaign. Otherwise, false.true
LastActivity datetimeDate of last activity on Account2001-01-01T12:00:00
LastProcessed datetimeDatetime of last action done on campaign.2001-01-01T01:01:01
Name stringFilenameattachment.txt
OpenedCount intTotal emails opened.1000
ParentChannelID intId number of parent channel123456
ParentChannelName string
PoolName stringName of your custom IP Pool to be used in the sending processMy Custom Pool
RecipientCount intOverall number of recipients1000
SentCount intTotal emails sent.1000
SplitOptimization SplitOptimizationWhat should be checked for choosing the winner: opens or clicks0
SplitOptimizationMinutes intNumber of minutes between sends during optimization period30
Status CampaignStatusName of campaign's status
Targets Repeated list of stringList of Segment and List IDs, preceded with 'l' for Lists and 's' for Segments, comma separateds01,l10
TemplateChannels List of CampaignChannelList of CampaignTemplate for sending A-X split testing.CampaignTemplate1, CampaignTemplate2
TemplateFromEmail stringDefault From: email address.sender@yourdomain.com
TemplateFromName stringDefault From: name.Sender
TemplateID intID number of template.1234
TemplateName stringName of template.Template01
TemplateReplyEmail stringDefault Reply: email address.replyto@yourdomain.com
TemplateReplyName stringDefault Reply: name.Reply
TemplateSubject stringDefault subject of email.Hello!
TimingOption int
TrackClicks booleanShould the clicks be tracked? If no value has been provided, Account's default setting will be used.true
TrackOpens booleanShould the opens be tracked? If no value has been provided, Account's default setting will be used.true
TriggerChannelID intWhich Channel's event should trigger this Campaign12345
TriggerChannelName string
TriggerCount intHow many times should the campaign be sent1
TriggerData stringData for filtering event campaigns such as specific link addresses.http://elasticemail.com
TriggerDate datetimeDate of triggered send2001-01-01T12:00:00
TriggerDelay doubleHow far into the future should the campaign be sent, in minutes20
TriggerFrequency doubleWhen your next automatic mail will be sent, in minutes30
TriggerType CampaignTriggerTypeNumber of event, triggering mail sending1
UnsubscribedCount intTotal emails unsubscribed1000
UtmCampaign stringThe utm_campaign marketing parameter appended to each link in the campaign.campaign1
UtmContent stringThe utm_content marketing parameter appended to each link in the campaign.content1
UtmMedium stringThe utm_medium marketing parameter appended to each link in the campaign.medium1
UtmSource stringThe utm_source marketing parameter appended to each link in the campaign.source1

CampaignStatus Enumeration

NameValueDescription
Deleted -1Campaign is logically deleted and not returned by API or interface calls.
Active 0Campaign is curently active and available.
Processing 1Campaign is currently being processed for delivery.
Sending 2Campaign is currently sending.
Completed 3Campaign has completed sending.
Paused 4Campaign is currently paused and not sending.
Cancelled 5Campaign has been cancelled during delivery.
Draft 6Campaign is save as draft and not processing.

CampaignTemplate

PropertyTypeDescriptionExample
CampaignTemplateID int
CampaignTemplateName string
PoolName stringName of your custom IP Pool to be used in the sending processMy Custom Pool
Status CampaignStatusName of campaign's status
TemplateFromEmail stringDefault From: email address.sender@yourdomain.com
TemplateFromName stringDefault From: name.Sender
TemplateID intID number of template.1234
TemplateName stringName of template.Template01
TemplateReplyEmail stringDefault Reply: email address.replyto@yourdomain.com
TemplateReplyName stringDefault Reply: name.Reply
TemplateSubject stringDefault subject of email.Hello!
UtmCampaign stringThe utm_campaign marketing parameter appended to each link in the campaign.campaign1
UtmContent stringThe utm_content marketing parameter appended to each link in the campaign.content1
UtmMedium stringThe utm_medium marketing parameter appended to each link in the campaign.medium1
UtmSource stringThe utm_source marketing parameter appended to each link in the campaign.source1

CampaignTriggerType Enumeration

NameValueDescription
SendNow 1
FutureScheduled 2
OnAdd 3
OnOpen 4
OnClick 5

CertificateValidationStatus Enumeration

NameValueDescription
ErrorOccured -2
CertNotSet 0
Valid 1
NotValid 2

Channel

SMTP and HTTP API channel for grouping email delivery

PropertyTypeDescriptionExample
ChannelID intChannel identifier.
ClickedCount intThe number of emails that have been clicked within this channel.
Cost decimalThe total cost for emails/attachments within this channel.
DateAdded datetimeThe date the channel was added to your account.
FailedAbuse intThe number of emails that have been marked as abuse or complaint within this channel.
FailedCount intThe number of emails that have been bounced within this channel.
JobCount intThe number of email jobs this channel has been used with.
LastActivity datetimeThe date the channel was last sent through.
Name stringDescriptive name of the channel.
OpenedCount intThe number of emails that have been opened within this channel.
RecipientCount intThe number of emails attempted to be sent within this channel.
SentCount intThe number of emails that have been sent within this channel.
UnsubscribedCount intThe number of emails that have been unsubscribed within this channel.

CompressionFormat Enumeration

FileResponse compression format

NameValueDescription
None 0No compression
Zip 1Zip compression

ConsentTracking Enumeration

NameValueDescription
Unknown 0
Allow 1
Deny 2

Contact

Contact

PropertyTypeDescriptionExample
BounceCount int
BouncedErrorCode intRFC Error code550
BouncedErrorMessage stringRFC error messageMailbox not found
ConsentDate datetimeDate 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 stringIP 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
ContactScore int
CreatedFromIP stringIP address192.168.0.1
CustomFields Repeated list of string keys and string valuesCustom contact field like companyname, customernumber, city etc. JSON serialized text like { "city":"london" } english
DateAdded datetimeDate of creation in YYYY-MM-DDThh:ii:ss format2001-01-01T12:00:00
DateUpdated datetimeLast change date2001-01-01T12:00:00
Email stringProper email address.mail@example.com
ErrorCode intRFC Error code550
FirstFailedDate datetimeDate of first failed message2001-01-01T12:00:00
FirstName stringFirst name.Fred
FriendlyErrorMessage stringRFC error messageMailbox not found
LastClicked datetime
LastFailedCount intNumber of fails in sending to this Contact1
LastName stringLast name.Flintstone
LastOpened datetimeDate this contact last opened an email2014-01-01
Notes stringFree form field of notesContact is extremely important!
Source ContactSourceSource of URL of paymenthttp://
Status ContactStatusStatus of the given resource1
TotalClicked intTotal emails clicked1000
TotalFailed intTotal emails failed.1000
TotalOpened intTotal emails opened.1000
TotalSent intTotal emails sent.1000
UnsubscribedDate datetimeUnsubscribed date in YYYY-MM-DD format2001-01-01
WebsiteUrl stringWebsite of contacthttp://

ContactCollection

Collection of lists and segments

PropertyTypeDescriptionExample
Lists List of ContactContainerLists which contain the requested contact
Segments List of ContactContainerSegments which contain the requested contact

ContactContainer

List's or segment's short info

PropertyTypeDescriptionExample
ID intID of the list/segment
Name stringName of the list/segment

ContactHistEventType Enumeration

NameValueDescription
Opened 2Contact opened an e-mail
Clicked 3Contact clicked an e-mail
Bounced 10E-mail sent to the contact bounced
Unsubscribed 11Contact unsubscribed
Complained 12Contact complained to an e-mail
Activated 20Contact clicked an activation link
TransactionalUnsubscribed 21Contact has opted to receive Transactional-only e-mails
ManualStatusChange 22Contact's status was changed manually
ActivationSent 24An Activation e-mail was sent
Deleted 28Contact was deleted

ContactHistory

History of chosen Contact

PropertyTypeDescriptionExample
ChannelName stringName of selected channel.Channel01
ContactHistoryID longID of history of selected Contact.123456
Country stringCountry of the event.
Data stringInformation about the event
EventDate stringFormatted date of event.1/1/2015 0:00:00 AM
EventType stringType of event occured on this Contact.Sent
EventTypeValue ContactHistEventTypeNumeric code of event occured on this Contact.1
IPAddress stringIP Address of the event.
TemplateName stringName of template.Template01

ContactSort Enumeration

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

ContactSource Enumeration

NameValueDescription
DeliveryApi 0Source of the contact is from sending an email via our SMTP or HTTP API's
ManualInput 1Contact was manually entered from the interface.
FileUpload 2Contact was uploaded via a file such as CSV.
WebForm 3Contact was added from a public web form.
ContactApi 4Contact was added from the contact api.
VerificationApi 5Contact was added via the verification api.
FileVerificationApi 6Contacts were added via bulk verification api.

ContactStatus Enumeration

NameValueDescription
Transactional -2Only transactional email can be sent to contacts with this status.
Engaged -1Contact has had an open or click in the last 6 months.
Active 0Contact is eligible to be sent to.
Bounced 1Contact has had a hard bounce and is no longer eligible to be sent to.
Unsubscribed 2Contact has unsubscribed and is no longer eligible to be sent to.
Abuse 3Contact has complained and is no longer eligible to be sent to.
Inactive 4Contact has not been activated or has been de-activated and is not eligible to be sent to.
Stale 5Contact has not been opening emails for a long period of time and is not eligible to be sent to.
NotConfirmed 6Contact has not confirmed their double opt-in activation and is not eligible to be sent to.

ContactStatusCounts

Number of Contacts, grouped by Status;

PropertyTypeDescriptionExample
Active longNumber of active contacts1000
Bounced longNumber of bounced messages1000
Complaint longNumber of complaint messages1000
Engaged longNumber of engaged contacts1000
Inactive longNumber of inactive contacts1000
NotConfirmed long
Stale long
Transactional longNumber of transactional contacts1000
Unsubscribed longNumber of unsubscribed messages1000

ContactUnsubscribeReasonCounts

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

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

PropertyTypeDescriptionExample
Bounced intNumber of bounced messages1000
Clicked intNumber of clicked messages1000
Complaint intNumber of complaint messages1000
Date stringDate in YYYY-MM-DDThh:ii:ss format2001-01-01T12:00:00
Delivered intNumber of delivered messages1000
Email intProper email address.mail@example.com
Inbound intNumber of inbound messages1000
ManualCancel intNumber of manually cancelled messages1000
NotDelivered intNumber of messages flagged with 'Not Delivered'0
Opened intNumber of opened messages1000
Sms intNumber of SMS12
Unsubscribed intNumber of unsubscribed messages1000

DomainDetail

Domain data, with information about domain records.

PropertyTypeDescriptionExample
CertificateStatus CertificateValidationStatus
CertificateValidationError string
CustomBouncesDomain string
DefaultDomain booleanTrue, if domain is used as default. Otherwise, false,
Dkim booleanTrue, if DKIM record is verifiedtrue
DMARC boolean
Domain stringName of selected domain.example.com
IsCustomBouncesDomainDefault boolean
IsRewriteDomainValid booleanTrue, if tracking CNAME record is verifiedtrue
MX booleanTrue, if MX record is verifiedtrue
Spf booleanTrue, if SPF record is verifiedtrue
TrackingStatus TrackingValidationStatus0 - 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 booleanTrue, if verification is availabletrue
VERP boolean

EmailCredits

Detailed information about email credits

PropertyTypeDescriptionExample
Amount decimalAmount of money in transaction100
Date datetimeDate in YYYY-MM-DDThh:ii:ss format2001-01-01T12:00:00
Notes stringFree form field of notesContact is extremely important!
Source stringSource of URL of paymenthttp://

EmailJobFailedStatus

PropertyTypeDescriptionExample
Address string
Category string
Error string
ErrorCode intRFC Error code550

EmailJobStatus

PropertyTypeDescriptionExample
AbuseReports List of string
AbuseReportsCount int
Clicked List of stringNumber of clicked messages1000
ClickedCount intTotal emails clicked1000
Delivered List of stringNumber of delivered messages1000
DeliveredCount int
Failed List of EmailJobFailedStatus
FailedCount intTotal emails failed.1000
ID stringID number of your attachment123456
MessageIDs List of stringList of all MessageIDs for this job.
Opened List of stringNumber of opened messages1000
OpenedCount intTotal emails opened.1000
Pending List of string
PendingCount int
RecipientsCount int
Sent List of string
SentCount intTotal emails sent.1000
Status stringName of status: submitted, complete, in_progress
Unsubscribed List of stringNumber of unsubscribed messages1000
UnsubscribedCount intTotal emails unsubscribed1000

EmailSend

PropertyTypeDescriptionExample
MessageID stringUnique identifier for this email.-HHGPM_9RPhSMiaJq_ab4g3
TransactionID stringID number of transactionTransactionID

EmailStatus

Status information of the specified email

PropertyTypeDescriptionExample
Date datetimeDate the email was submitted.
DateClicked datetimeDate when the email changed the status to 'clicked'2001-01-01T12:00:00
DateOpened datetimeDate when the email changed the status to 'opened'2001-01-01T12:00:00
DateSent datetimeDate when the email was sent2001-01-01T12:00:00
ErrorMessage stringDetailed error or bounced message.
From stringEmail address this email was sent from.
Status LogJobStatusValue of email's status
StatusChangeDate datetimeDate of last status change.2001-01-01T12:00:00
StatusName stringName of email's status
To stringEmail address this email was sent to.
TransactionID GUIDID number of transactionTransactionID

EmailValidationResult

PropertyTypeDescriptionExample
Account string
Disposable boolean
Domain stringName of selected domain.example.com
Email stringProper email address.mail@example.com
Reason stringReason for blocking (1 - bounced, 2 - unsubscribed, 3 - spam).1
Result EmailValidationStatus
Role boolean
SuggestedSpelling string

EmailValidationStatus Enumeration

NameValueDescription
None 0
Valid 1
Unknown 2
Risky 3
Invalid 4

EmailView

Email details formatted in json

PropertyTypeDescriptionExample
Body stringBody (text) of your message.Hello
From stringStarting date for search in YYYY-MM-DDThh:mm:ss format.2001-01-01T01:01:01
Subject stringDefault subject of email.Hello!

EncodingType Enumeration

Encoding type for the email headers

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

EventLog

Event logs for selected date range

PropertyTypeDescriptionExample
From datetimeStarting date for search in YYYY-MM-DDThh:mm:ss format.2001-01-01T01:01:01
Recipients List of RecipientEventNumber of recipients1234
To datetimeEnding date for search in YYYY-MM-DDThh:mm:ss format.2001-01-01T01:01:01

Export

Record of exported data from the system.

PropertyTypeDescriptionExample
DateAdded datetimeDate the export was created.
ExportStatus ExportStatusStatus of the exportReady
ExportType ExportTypeType of export123456
Filename stringName of the exported file.
Info stringLong description of the export.
Link stringLink to download the export.
LogFrom datetimeLog start date (for Type = Log only).
LogTo datetimeLog end date (for Type = Log only).
PublicExportID GUIDID of the exported file123456

ExportFileFormats Enumeration

Format of the exported file.

NameValueDescription
Csv 1Export in comma separated values format.
Xml 2Export in xml format.
Json 3Export in json format.

ExportLink

PropertyTypeDescriptionExample
Link stringDirect URL to the exported file
PublicExportID GUIDID of the exported file123456

ExportStatus Enumeration

Current status of the export.

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

ExportType Enumeration

Type of export.

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

File

PropertyTypeDescriptionExample
ContentType stringContent type of the file.
DateAdded datetimeDate of creation in YYYY-MM-DDThh:ii:ss format2001-01-01T12:00:00
ExpirationDate datetimeDate when the file be deleted from your Account.
FileName stringName of your file including extension.filename.txt
Size intSize of your attachment (in bytes).100

InboundOptions

Lists inbound options of your account.

PropertyTypeDescriptionExample
HubCallbackUrl stringURL used for tracking action of inbound emailshttp://
InboundContactsOnly booleanTrue, if you want inbound email to only process contacts from your Account. Otherwise, falsetrue
InboundDomain stringDomain you use as your inbound domainyourdomain.com

IntervalType Enumeration

NameValueDescription
Summary 0Daily overview
Hourly 1Hourly, detailed information

LinkTrackingDetails

Object containig tracking data.

PropertyTypeDescriptionExample
Count intNumber of items.100
MoreAvailable booleanTrue, if there are more detailed data available. Otherwise, falsetrue
TrackedLink List of TrackedLink

List

List of Lists, with detailed data about its contents.

PropertyTypeDescriptionExample
AllowUnsubscribe booleanTrue: Allow unsubscribing from this list. Otherwise, falsetrue/false
Count intNumber of items.100
DateAdded datetimeDate of creation in YYYY-MM-DDThh:ii:ss format2001-01-01T12:00:00
ListID intID number of selected list.1234
ListName stringName of your list.My List 1
PublicListID GUIDID code of listpublic-id-of-your-list
Rule stringQuery used for filtering.Status%20=%20Engaged

Log

Logs for selected date range

PropertyTypeDescriptionExample
From datetimeStarting date for search in YYYY-MM-DDThh:mm:ss format.2001-01-01T01:01:01
Recipients List of RecipientNumber of recipients1234
To datetimeEnding date for search in YYYY-MM-DDThh:mm:ss format.2001-01-01T01:01:01

LogEventStatus Enumeration

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

LogJobStatus Enumeration

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

LogStatusSummary

Summary of log status, based on specified date range.

PropertyTypeDescriptionExample
Bounced longNumber of bounced messages1000
Clicked longNumber of clicked messages1000
Complaints longNumber of complaint messages1000
Delivered longNumber of delivered messages1000
Duration doubleOverall duration
EmailTotal longNumber of emails1234
From stringStarting date for search in YYYY-MM-DDThh:mm:ss format.2001-01-01T01:01:01
Inbound longNumber of inbound messages1000
InProgress longNumber of messages in progress1234
ManualCancel longNumber of manually cancelled messages1000
NotDelivered longNumber of messages flagged with 'Not Delivered'0
Opened longNumber of opened messages1000
Recipients longNumber of recipients1234
SmsTotal longNumber of SMS12
TemplateChannel booleanID number of template used1234
To stringEnding date for search in YYYY-MM-DDThh:mm:ss format.2001-01-01T01:01:01
Unsubscribed longNumber of unsubscribed messages1000

LogSummary

Overall log summary information.

PropertyTypeDescriptionExample
BouncedCategorySummary BouncedCategorySummarySummary of bounced categories, based on specified date range.
DailyLogStatusSummary List of DailyLogStatusSummaryDaily summary of log status, based on specified date range.
LogStatusSummary LogStatusSummarySummary of log status, based on specified date range.
SubaccountSummary SubaccountSummary

MessageCategory Enumeration

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

NotificationType Enumeration

NameValueDescription
All 0Both, email and web, notifications
Email 1Only email notifications
Web 2Only web notifications

Payment

Detailed information about existing money transfers.

PropertyTypeDescriptionExample
Amount decimalAmount of money in transaction100
Date datetimeDate in YYYY-MM-DDThh:ii:ss format2001-01-01T12:00:00
DiscountPercent decimal
RegularAmount decimal
Source stringSource of URL of paymenthttp://

Profile

Basic information about your profile

PropertyTypeDescriptionExample
Address1 stringFirst line of address.12 Granite Road
Address2 stringSecond line of address.Apartment B
City stringCity.Bedrock
Company stringCompany name.Slate
CountryID intNumeric ID of country. A file with the list of countries is available here12345
DeliveryReason stringWhy your clients are receiving your emails.Reason
Email stringProper email address.mail@example.com
FirstName stringFirst name.Fred
LastName stringLast name.Flintstone
LogoUrl stringURL to your logo image.http://yourdomain.com/logo.png
MarketingConsent booleanTrue if you want to receive newsletters from Elastic Email. Otherwise, false. Empty to leave the current value.true/false
Phone stringPhone number1234567890
State stringState or province.CA
TaxCode stringCode used for tax purposes.
Website stringHTTP address of your website.http://example.com
Zip stringZip/postal code.00000

Recipient

Detailed information about message recipient

PropertyTypeDescriptionExample
Channel stringName of selected Channel.Channel01
ContactLastError stringRecipient's last bounce error because of which this e-mail was suppressedThe email address does not exist
Date stringCreation date
DateClicked stringDate when the email changed the status to 'clicked'2001-01-01T12:00:00
DateOpened stringDate when the email changed the status to 'opened'2001-01-01T12:00:00
DateSent stringDate when the email was sent2001-01-01T12:00:00
EnvelopeFrom string
FromEmail stringDefault From: email address.sender@yourdomain.com
IPAddress string
IsSms booleanTrue, if message is SMS. Otherwise, falsetrue
JobID stringID of certain mail job
Message stringContent of message, HTML encodedLorem ipsum
MessageCategory stringName of message category
MessageCategoryID MessageCategoryID of message category
MessageSid stringComma separated ID numbers of messages.12345678,1234567890
MsgID stringID number of selected message.ABCDE_9RPhSWiaJq_ab1g1
NextTryOn stringDate of next try2001-01-01T12:00:00
ShowCategory booleanTrue, if message category should be shown. Otherwise, falsetrue
SmsUpdateRequired booleanTrue, if message is a SMS and status is not yet confirmed. Otherwise, falsefalse
Status stringName of recipient's status: Submitted, ReadyToSend, WaitingToRetry, Sending, Bounced, Sent, Opened, Clicked, Unsubscribed, AbuseReport
StatusChangeDate stringDate of last status change.2001-01-01T12:00:00
Subject stringDefault subject of email.Hello!
TextMessage stringContent of messageLorem ipsum
To stringEnding date for search in YYYY-MM-DDThh:mm:ss format.2001-01-01T01:01:01

RecipientEvent

Detailed information about message recipient

PropertyTypeDescriptionExample
Channel stringName of selected Channel.Channel01
ChannelID intID number of selected Channel.123456
EventDate stringCreation date
EventType stringName of recipient's status: Submitted, ReadyToSend, WaitingToRetry, Sending, Bounced, Sent, Opened, Clicked, Unsubscribed, AbuseReport
FromEmail stringDefault From: email address.sender@yourdomain.com
IPAddress string
IPPoolName string
JobID stringID of certain mail job
Message stringContent of message, HTML encodedLorem ipsum
MessageCategory stringName of message category
MsgID stringID number of selected message.ABCDE_9RPhSWiaJq_ab1g1
NextTryOn stringDate of next try2001-01-01T12:00:00
Subject stringDefault subject of email.Hello!
To stringEnding date for search in YYYY-MM-DDThh:mm:ss format.2001-01-01T01:01:01

Referral

Referral details for this account.

PropertyTypeDescriptionExample
CurrentReferralCount longNumber of active referrals.5
CurrentReferralCredit decimalCurrent amount of dolars you have from referring.10

ReputationDetail

Detailed sending reputation of your account.

PropertyTypeDescriptionExample
AbusePercent doublePercent of Complaining users - those, who do not want to receive email from you.0.00
AverageSpamScore doublePenalty from messages marked as spam.0
ClickedPercent double
FailedSpamPercent doublePercent of Bounced users0.00
Impact ReputationImpactOverall reputation impact, based on the most important factors.
OpenedPercent double
UnknownUsersPercent doublePercent of Unknown users - users that couldn't be found0.00

ReputationHistory

Reputation history of your account.

PropertyTypeDescriptionExample
AbusePercent doublePercent of Complaining users - those, who do not want to receive email from you.0.00
AverageSpamScore doublePenalty from messages marked as spam.0
ClickedPercent double
DateCreated stringCreation date.2001-01-01T12:00:00
OpenedPercent double
RepEmailsSent doubleNumber of emails included in the current reputation score.0
Reputation doubleNumeric reputation100
SetupScore doublePoints from proper setup of your Account0
UnknownUsersPercent doublePercent of Unknown users - users that couldn't be found0.00

ReputationImpact

Overall reputation impact, based on the most important factors.

PropertyTypeDescriptionExample
Abuse doubleAbuses - mails sent to user without their consent0.00
AverageSpamScore doublePenalty from messages marked as spam.0
Clicked doubleNumber of clicked messages1000
Opened doubleNumber of opened messages1000
ServerFilter doubleContent analysis.0.00
UnknownUsers doubleUsers, that could not be reached.0.00

Segment

Information about Contact Segment, selected by RULE.

PropertyTypeDescriptionExample
History List of SegmentHistoryHistory of segment information.
LastCount longNumber of items from last check.100
Name stringFilenameattachment.txt
Rule stringQuery used for filtering.Status%20=%20Engaged
SegmentID intID number of your segment.1234

SegmentHistory

Segment History

PropertyTypeDescriptionExample
Count longNumber of items.100
Day intDate in YYYY-MM-DD format2001-01-01
SegmentHistoryID intID number of history.1234567
SegmentID intID number of your segment.1234

SendingPermission Enumeration

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

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

SpamCheck

Spam check of specified message.

PropertyTypeDescriptionExample
ChannelName stringName of selected channel.Channel01
Date stringDate in YYYY-MM-DDThh:ii:ss format2001-01-01T12:00:00
FromEmail stringDefault From: email address.sender@yourdomain.com
MsgID stringID number of selected message.ABCDE_9RPhSWiaJq_ab1g1
Rules List of SpamRule
Subject stringDefault subject of email.Hello!
TotalScore stringTotal spam score from5.5

SpamRule

Single spam score

PropertyTypeDescriptionExample
Description stringDescription of rule.Very long subject, possibly filled up with random
Key stringName of ruleJAM_LONG_SUBJECT
Score stringSpam score2.5

SplitOptimization Enumeration

NameValueDescription
Opened 0Number of opened messages
Clicked 1Number of clicked messages

SubAccount

Detailed information about Sub-Account.

PropertyTypeDescriptionExample
AbusePercent doublePercent of Complaining users - those, who do not want to receive email from you.0.00
ApiKey stringApiKey that gives you access to our SMTP and HTTP API's.94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3
ContactsCount int
DailySendLimit longAmount of emails Account can send daily100000
Email stringProper email address.mail@example.com
EmailCredits stringAmount of email credits1000
EmailSizeLimit intMaximum size of email including attachments in MB's10
EnablePrivateIPRequest booleanTrue, if Account can request for private IP on its own. Otherwise, falsetrue
FailedSpamPercent doublePercent of Bounced users0.00
HasModify2FA boolean
LastActivity stringDate of last activity on Account2001-01-01T12:00:00
MailerID stringID number of mailer-9
MaxContacts intMaximum number of contacts the Account can have100000
MonthlyRefillCredits doubleAmount of credits added to Account automatically1000
PoolName stringName of your custom IP Pool to be used in the sending processMy Custom Pool
PublicAccountID string
Reputation doubleNumeric reputation100
RequiresEmailCredits booleanTrue, if Account needs credits to send emails. Otherwise, falsetrue
SendingPermission SendingPermissionSending permission setting for AccountAll
Status stringAccount's current status.
TotalEmailsSent longAmount of emails sent from this Account1000
UnknownUsersPercent doublePercent of Unknown users - users that couldn't be found0.00

SubAccountSettings

Detailed settings of Sub-Account.

PropertyTypeDescriptionExample
Allow2FA booleanTrue, if you want to allow two-factor authentication. Otherwise, false.
DailySendLimit intAmount of emails Account can send daily100000
Email stringProper email address.mail@example.com
EmailSizeLimit intMaximum size of email including attachments in MB's10
EnableContactFeatures booleanTrue, if you want to use Contact Delivery Tools. Otherwise, false
EnablePrivateIPRequest booleanTrue, if Account can request for private IP on its own. Otherwise, falsetrue
MaxContacts intMaximum number of contacts the Account can have100000
MonthlyRefillCredits doubleAmount of credits added to Account automatically1000
PoolName stringName of your custom IP Pool to be used in the sending processMy Custom Pool
PublicAccountID string
RequiresEmailCredits booleanTrue, if Account needs credits to send emails. Otherwise, falsetrue
SendingPermission SendingPermissionSending permission setting for AccountAll

SubaccountSummary

PropertyTypeDescriptionExample
EmailsSentThisMonth int
EmailsSentToday int

SupportPlan Enumeration

Add-on support options for your Account.

NameValueDescription
Priority 1In-app support option for $1/day.
Premium 2In-app real-time chat support option for $7/day.

Template

Template

PropertyTypeDescriptionExample
BodyAmp stringAMP code of email (needs escaping).<BODY><H1>Hello!</H1></BODY>
BodyHtml stringHTML code of email (needs escaping).<BODY><H1>Hello!</H1></BODY>
BodyText stringText body of email.Hello%20World
Css stringCSS stylebody:{color:black;}
DateAdded datetimeDate of creation in YYYY-MM-DDThh:ii:ss format2001-01-01T12:00:00
FromEmail stringDefault From: email address.sender@yourdomain.com
FromName stringDefault From: name.Sender
Name stringFilenameattachment.txt
OriginalTemplateID intID number of original template.123
OriginalTemplateName string
Subject stringDefault subject of email.Hello!
Tags List of stringTemplate's Tags
TemplateID intID number of template.1234
TemplateScope TemplateScopeEnum: 0 - private, 1 - public, 2 - mockup1
TemplateType TemplateType0 for API connections0

TemplateList

List of templates (including drafts)

PropertyTypeDescriptionExample
DraftTemplate List of TemplateList of draft templates
DraftTemplatesCount intTotal of draft templates
Templates List of TemplateList of templates
TemplatesCount intTotal of templates

TemplateScope Enumeration

NameValueDescription
Private 0Template is available for this account only.
Public 1Template is available for this account and it's sub-accounts.
Draft 2Template is a temporary draft, not to be used permanently.

TemplateTag

Tag used for tagging multiple Templates

PropertyTypeDescriptionExample
Name stringTag's value

TemplateTagList

A list of your personal and global Template Tags

PropertyTypeDescriptionExample
GlobalTags List of TemplateTagList of globally available Tags
Tags List of TemplateTagList of personal Tags

TemplateType Enumeration

NameValueDescription
RawHTML 0Template supports any valid HTML
DragDropEditor 1Template is created for email and can only be modified in the drag and drop email editor
LandingPageEditor 2Template is created for landing page and can only be modified in the drag and drop langing page editor

TrackedLink

Information about tracking link and its clicks.

PropertyTypeDescriptionExample
Clicks stringNumber of clicks10
Link stringURL clickedhttp://
Percent stringPercent of clicks10%

TrackingType Enumeration

HTTP or HTTPS Protocal used for link tracking.

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

TrackingValidationStatus Enumeration

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

NameValueDescription
Validated 0
NotValidated 1
Invalid 2
Broken 3

Usage

Account usage

PropertyTypeDescriptionExample
Email stringProper email address.mail@example.com
IsSubAccount booleanTrue, if this Account is a Sub-Account. Otherwise, falsetrue
List List of UsageData

UsageData

Detailed data about daily usage

PropertyTypeDescriptionExample
AttachmentCount intNumber of attachments sent10
AttachmentsSize longSize of attachments sent1024
ContactCost decimalDaily cost of Contact Delivery Tools12.34
ContactCount longNumber of contacts10000
Cost decimalCalculated cost of sending12.34
Date datetimeDate in YYYY-MM-DDThh:ii:ss format2001-01-01T12:00:00
EmailCost decimal
EmailCreditsCost intCost of email credits.0001
InboundCount intNumber of inbound emails1000
InboundEmailCost decimal
InboundEmailCount int
JobCount intNumber of finished tasks10
PrivateIPCost decimal
PrivateIPCount intNumber of pricate IPs2
RecipientCount intOverall number of recipients1000
SmsCost decimalOverall cost of SMS1.23
SmsCount intNumber of SMS12
SupportCost decimal
VerificationCost decimal
VerificationCount int

ValidationError

PropertyTypeDescriptionExample
Error string
TXTRecord string

ValidationStatus

PropertyTypeDescriptionExample
Errors List of ValidationError
IsValid boolean
Log string

ValidEmail

PropertyTypeDescriptionExample

Webhook

Notification webhook setting

PropertyTypeDescriptionExample
DateCreated datetimeCreation date.2001-01-01T12:00:00
DateUpdated datetimeLast change date2001-01-01T12:00:00
Name stringFilenameattachment.txt
NotificationForAbuseReport boolean
NotificationForClicked boolean
NotificationForError boolean
NotificationForOpened boolean
NotificationForSent boolean
NotificationForUnsubscribed boolean
NotifyOncePerEmail boolean
URL stringURL of notification.http://address.for.notification.com
WebhookID stringPublic webhook ID

WebNotificationOptions

Lists web notification options of your account.

PropertyTypeDescriptionExample
WebNotificationForAbuse booleanTrue, if you want to send web notifications for complaint email. Otherwise, falsetrue
WebNotificationForClicked booleanTrue, if you want to send web notifications for clicked email. Otherwise, falsetrue
WebNotificationForError booleanTrue, if you want to send web notifications for bounced email. Otherwise, falsetrue
WebNotificationForOpened booleanTrue, if you want to send web notifications for opened email. Otherwise, falsetrue
WebNotificationForSent booleanTrue, if you want to send web notifications for sent email. Otherwise, falsetrue
WebnotificationForUnsubscribed booleanTrue, if you want to send web notifications for unsubscribed email. Otherwise, falsetrue
WebNotificationNotifyOncePerEmail booleanTrue, if you want to receive notifications for each type only once per email. Otherwise, falsetrue
WebNotificationUrl stringURL address to receive web notifications to parse and process.http://