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.

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://elasticemail.com/support/http-api/integration-libraries

Account
Methods for managing your account and subaccounts.

AddSubAccount
Create new subaccount and provide most important data about it.


/Account/AddSubAccount
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
confirmPasswordstringYesRepeat new password.
emailstringYesProper email address.
enableContactFeaturesboolean?NonullTrue, if you want to use Advanced Tools. Otherwise, false
enableLitmusTestbooleanNofalseTrue, if account is able to send template tests to Litmus. Otherwise, false
enablePrivateIPRequestbooleanNotrueTrue, if account can request for private IP on its own. Otherwise, false
maxContactsintNo0Maximum number of contacts the account can havelkd
passwordstringYesCurrent password.
poolNamestringNonullPrivate 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
requiresEmailCreditsbooleanNofalseTrue, if account needs credits to send emails. Otherwise, false
requiresLitmusCreditsbooleanNofalseTrue, 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
sendingPermissionSendingPermission?NonullSending permission setting for account

Returns

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

Example copy link

https://api.elasticemail.com/v2/account/addsubaccount?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&email=mail@example.com&password=********&confirmPassword=********&requiresEmailCredits=True&enableLitmusTest=False&requiresLitmusCredits=True&maxContacts=100000&enablePrivateIPRequest=True&sendActivation=false&returnUrl=http://yourdomain.com&sendingPermission=All&enableContactFeatures=&poolName=
Back to top

AddSubAccountCredits
Add email, template or litmus credits to a sub-account


/Account/AddSubAccountCredits
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
creditsintYesAmount of credits to add
creditTypestringYesType of credits to add (EmailCredits, TemplateCredits or LitmusCredits
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, "error": null, "data": "" }

Example copy link

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

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


/Account/ChangeEmail
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
confirmEmailstringYesNew email address.
newEmailstringYesNew email address.
sourceUrlstringYesURL from which request was sent.

Returns

{"success": true, "error": null, "data": "" }

Example copy link

https://api.elasticemail.com/v2/account/changeemail?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&sourceUrl=http://source.url.com&newEmail=newmail@example.com&confirmEmail=newmail@example.com
Back to top

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


/Account/ChangePassword
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
confirmPasswordstringYesRepeat new password.
currentPasswordstringYesCurrent password.
newPasswordstringYesNew password for account.

Returns

{"success": true, "error": null, "data": "" }

Example copy link

https://api.elasticemail.com/v2/account/changepassword?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&currentPassword=********&newPassword=********&confirmPassword=********
Back to top

DeleteSubAccount
Deletes specified Subaccount


/Account/DeleteSubAccount
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
notifybooleanNotrueTrue, if you want to send an email notification. Otherwise, false
publicAccountIDstringNonullPublic key of sub-account to delete. Use subAccountEmail or publicAccountID not both.
subAccountEmailstringNonullEmail address of sub-account

Returns

{"success": true, "error": null, "data": "" }

Example copy link

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

GetSubAccountApiKey
Returns API Key for the given Sub Account.


/Account/GetSubAccountApiKey
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
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, "error": null, "data": { string } }

Example copy link

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

GetSubAccountList
Lists all of your subaccounts


/Account/GetSubAccountList
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.

Returns

{"success": true, "error": null, "data": { List of SubAccount } }

Example copy link

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

Load
Loads your account. Returns detailed information about your account.


/Account/Load
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.

Returns

{"success": true, "error": null, "data": { Account } }

Example copy link

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

LoadAdvancedOptions
Load advanced options of your account


/Account/LoadAdvancedOptions
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.

Returns

{"success": true, "error": null, "data": { AdvancedOptions } }

Example copy link

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

LoadEmailCreditsHistory
Lists email credits history


/Account/LoadEmailCreditsHistory
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.

Returns

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

Example copy link

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

LoadLitmusCreditsHistory
Lists litmus credits history


/Account/LoadLitmusCreditsHistory
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.

Returns

{"success": true, "error": null, "data": { List of LitmusCredits } }

Example copy link

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

LoadNotificationQueue
Shows queue of newest notifications - very useful when you want to check what happened with mails that were not received.


/Account/LoadNotificationQueue
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.

Returns

{"success": true, "error": null, "data": { List of NotificationQueue } }

Example copy link

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

LoadPaymentHistory
Lists all payments


/Account/LoadPaymentHistory
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
fromDatedatetimeYesStarting date for search in YYYY-MM-DDThh:mm:ss format.
limitintYesMaximum of loaded items.
offsetintYesHow many items should be loaded ahead.
toDatedatetimeYesEnding date for search in YYYY-MM-DDThh:mm:ss format.

Returns

{"success": true, "error": null, "data": { List of Payment } }

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
Back to top

LoadPayoutHistory
Lists all referral payout history


/Account/LoadPayoutHistory
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.

Returns

{"success": true, "error": null, "data": { List of Payment } }

Example copy link

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

LoadReferralDetails
Shows information about your referral details


/Account/LoadReferralDetails
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.

Returns

{"success": true, "error": null, "data": { Referral } }

Example copy link

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

LoadReputationHistory
Shows latest changes in your sending reputation


/Account/LoadReputationHistory
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
limitintNo20Maximum of loaded items.
offsetintNo0How many items should be loaded ahead.

Returns

{"success": true, "error": null, "data": { List of ReputationHistory } }

Example copy link

https://api.elasticemail.com/v2/account/loadreputationhistory?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&limit=100&offset=20
Back to top

LoadReputationImpact
Shows detailed information about your actual reputation score


/Account/LoadReputationImpact
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.

Returns

{"success": true, "error": null, "data": { ReputationDetail } }

Example copy link

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

LoadSpamCheck
Returns detailed spam check.


/Account/LoadSpamCheck
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
limitintNo20Maximum of loaded items.
offsetintNo0How many items should be loaded ahead.

Returns

{"success": true, "error": null, "data": { List of SpamCheck } }

Example copy link

https://api.elasticemail.com/v2/account/loadspamcheck?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&limit=100&offset=20
Back to top

LoadSubAccountsEmailCreditsHistory
Lists email credits history for sub-account


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

Returns

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

Example copy link

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

LoadSubAccountSettings
Loads settings of subaccount


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

Returns

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

Example copy link

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

LoadSubAccountsLitmusCreditsHistory
Lists litmus credits history for sub-account


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

Returns

{"success": true, "error": null, "data": { List of LitmusCredits } }

Example copy link

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

LoadUsage
Shows usage of your account in given time.


/Account/LoadUsage
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
fromdatetimeYesStarting date for search in YYYY-MM-DDThh:mm:ss format.
todatetimeYesEnding date for search in YYYY-MM-DDThh:mm:ss format.

Returns

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

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
Back to top

ManageApiKeys
Manages your apikeys.


/Account/ManageApiKeys
Name Type Required Default Description
actionAPIKeyActionYesSpecific action you would like to perform on the APIKey
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
apiKeystringYesAPIKey you would like to manage.

Returns

{"success": true, "error": null, "data": { List of string } }

Example copy link

https://api.elasticemail.com/v2/account/manageapikeys?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&apiKey=&action=
Back to top

Overview
Shows summary for your account.


/Account/Overview
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.

Returns

{"success": true, "error": null, "data": { AccountOverview } }

Example copy link

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

ProfileOverview
Shows you account's profile basic overview


/Account/ProfileOverview
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.

Returns

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

Example copy link

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

PurchasePrivateIP
Purchase a private IP for your Account


/Account/PurchasePrivateIP
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
regionstringNonullRegion of the IP Address (NA and EU currently available)

Returns

{"success": true, "error": null, "data": { PrivateIP } }

Example copy link

https://api.elasticemail.com/v2/account/purchaseprivateip?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&region=
Back to top

RemoveSubAccountCredits
Remove email, template or litmus credits from a sub-account


/Account/RemoveSubAccountCredits
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
creditsint?NonullAmount of credits to remove
creditTypestringYesType of credits to add (EmailCredits, TemplateCredits or LitmusCredits
notesstringYesSpecific notes about the transaction
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, "error": null, "data": "" }

Example copy link

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

RequestPrivateIP
Request a private IP for your Account


/Account/RequestPrivateIP
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
countintYesNumber of items.
notesstringYesFree form field of notes

Returns

{"success": true, "error": null, "data": "" }

Example copy link

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

UpdateAdvancedOptions
Update sending and tracking options of your account.


/Account/UpdateAdvancedOptions
Name Type Required Default Description
allowCustomHeadersboolean?NonullTrue, if you want to apply custom headers to your emails. Otherwise, false
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
autoTextFromHtmlboolean?NonullTrue, if text BODY of message should be created automatically. Otherwise, false
bccEmailstringNo""Email address to send a copy of all email to.
contentTransferEncodingstringNonullType of content encoding
emailNotificationEmailstringNo""Specific email address to send bounce email notifications to.
emailNotificationForErrorboolean?NonullTrue, if you want bounce notifications returned. Otherwise, false
enableClickTrackingboolean?NonullTrue, if you want to track clicks. Otherwise, false
enableContactFeaturesboolean?NonullTrue, if you want to use Advanced Tools. Otherwise, false
enableLinkClickTrackingboolean?NonullTrue, if you want to track by link tracking. Otherwise, false
enableUITooltipsboolean?NonullTrue, if account has tooltips active. Otherwise, false
hubCallBackUrlstringNo""URL used for tracking action of inbound emails
inboundContactsOnlyboolean?NonullTrue, if you want inbound email to only process contacts from your account. Otherwise, false
inboundDomainstringNo""Domain you use as your inbound domain
logoUrlstringNo""URL to your logo image.
lowCreditNotificationboolean?NonullTrue, if you want to receive low credit email notifications. Otherwise, false
manageSubscribedOnlyboolean?NonullTrue, if you want to only display labels that the contact is subscribed to on your unsubscribe form. Otherwise, false
manageSubscriptionsboolean?NonullTrue, if you want to display your labels on your unsubscribe form. Otherwise, false
notificationsEmailsstringNo""Email addresses to send a copy of all notifications from our system. Separated by semicolon
skipListUnsubscribeboolean?NonullTrue, if you do not want to use list-unsubscribe headers. Otherwise, false
transactionalOnUnsubscribeboolean?NonullTrue, if you want to display an option for the contact to opt into transactional email only on your unsubscribe form. Otherwise, false
webNotificationForAbuseReportboolean?NonullTrue, if you want to send web notifications for complaint email. Otherwise, false
webNotificationForClickedboolean?NonullTrue, if you want to send web notifications for clicked email. Otherwise, false
webNotificationForErrorboolean?NonullTrue, if you want to send web notifications for bounced email. Otherwise, false
webNotificationForOpenedboolean?NonullTrue, if you want to send web notifications for opened email. Otherwise, false
webNotificationForSentboolean?NonullTrue, if you want to send web notifications for sent email. Otherwise, false
webNotificationForUnsubscribedboolean?NonullTrue, if you want to send web notifications for unsubscribed email. Otherwise, false
webNotificationUrlstringNo""URL address to receive web notifications to parse and process.

Returns

{"success": true, "error": null, "data": { AdvancedOptions } }

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&webNotificationUrl=http://&webNotificationForSent=true&webNotificationForOpened=true&webNotificationForClicked=true&webNotificationForUnsubscribed=true&webNotificationForAbuseReport=true&webNotificationForError=true&hubCallBackUrl=http://&inboundDomain=yourdomain.com&inboundContactsOnly=true&lowCreditNotification=true&enableUITooltips=true&enableContactFeatures=&notificationsEmails=email1@example.com;email2@example.com&logoUrl=http://yourdomain.com/logo.png
Back to top

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


/Account/UpdateCustomBranding
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
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, "error": null, "data": "" }

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
Back to top

UpdateHttpNotification
Update http notification URL.


/Account/UpdateHttpNotification
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
settingsstringNonullHttp notification settings serialized to JSON
urlstringYesURL of notification.

Returns

{"success": true, "error": null, "data": "" }

Example copy link

https://api.elasticemail.com/v2/account/updatehttpnotification?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&url=http://address.for.notification.com&settings={ sent: true, opened: true, clicked: true, unsubscribed: true, complaints: true, error: true }
Back to top

UpdateProfile
Update your profile.


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

Returns

{"success": true, "error": null, "data": "" }

Example copy link

https://api.elasticemail.com/v2/account/updateprofile?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&firstName=FIRSTNAME&lastName=LASTNAME&address1=ADDRESS1&city=CITY&state=STATE&zip=ZIP/POSTAL&countryID=12345&deliveryReason=Reason&marketingConsent=true/false&address2=ADDRESS2&company=COMPANY&website=http://example.com&logoUrl=http://yourdomain.com/logo.png&taxCode=&phone=1234567890
Back to top

UpdateSubAccountSettings
Updates settings of specified subaccount


/Account/UpdateSubAccountSettings
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
dailySendLimitintNo50Amount of emails account can send daily
emailSizeLimitintNo10Maximum size of email including attachments in MB's
enableContactFeaturesboolean?NonullTrue, if you want to use Advanced Tools. Otherwise, false
enableLitmusTestbooleanNofalseTrue, if account is able to send template tests to Litmus. Otherwise, false
enablePrivateIPRequestbooleanNofalseTrue, if account can request for private IP on its own. Otherwise, false
maxContactsintNo0Maximum number of contacts the account can havelkd
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
requiresLitmusCreditsbooleanNofalseTrue, if account needs credits to send emails. Otherwise, false
sendingPermissionSendingPermission?NonullSending permission setting for account
subAccountEmailstringNonullEmail address of sub-account

Returns

{"success": true, "error": null, "data": "" }

Example copy link

https://api.elasticemail.com/v2/account/updatesubaccountsettings?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&requiresEmailCredits=True&monthlyRefillCredits=1000&requiresLitmusCredits=True&enableLitmusTest=False&dailySendLimit=100000&emailSizeLimit=10&enablePrivateIPRequest=True&maxContacts=100000&subAccountEmail=mail@example.com&publicAccountID=&sendingPermission=All&enableContactFeatures=&poolName=My Custom Pool
Back to top

Attachment
Managing attachments uploaded to your account.

Delete
Permanently deletes attachment file from your account


/Attachment/Delete
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
attachmentIDlongYesID number of your attachment.

Returns

{"success": true, "error": null, "data": "" }

Example copy link

https://api.elasticemail.com/v2/attachment/delete?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&attachmentID=123456
Back to top

Get
Gets address of chosen Attachment


/Attachment/Get
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
attachmentIDlongYesID number of your attachment.
fileNamestringYesName of your file.

Returns

{"success": true, "error": null, "data": { Output stream containing file data } }

Example copy link

https://api.elasticemail.com/v2/attachment/get?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&fileName=filename.txt&attachmentID=123456
Back to top

List
Lists your available Attachments


/Attachment/List
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
msgIDstringYesID number of selected message.

Returns

{"success": true, "error": null, "data": { List of Attachment } }

Example copy link

https://api.elasticemail.com/v2/attachment/list?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&msgID=MessageID
Back to top

Remove
Permanently removes attachment file from your account


/Attachment/Remove
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
fileNamestringYesName of your file.

Returns

{"success": true, "error": null, "data": "" }

Example copy link

https://api.elasticemail.com/v2/attachment/remove?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&fileName=filename.txt
Back to top

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


/Attachment/Upload
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.

Attach the file as POST multipart/form-data file upload or PUT file upload with content-disposition header

Returns

{"success": true, "error": null, "data": { Attachment } }

Example copy link

https://api.elasticemail.com/v2/attachment/upload?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3
Back to top

Campaign
Sending and monitoring progress of your Campaigns

Add
Adds a campaign to the queue for processing based on the configuration


/Campaign/Add
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
campaignCampaignYesJson representation of a campaign

Returns

{"success": true, "error": null, "data": { int } }

Example copy link

https://api.elasticemail.com/v2/campaign/add?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&campaign=
Back to top

Copy
Copy selected campaign


/Campaign/Copy
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
channelIDintYesID number of selected Channel.

Returns

{"success": true, "error": null, "data": "" }

Example copy link

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

Delete
Delete selected campaign


/Campaign/Delete
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
channelIDintYesID number of selected Channel.

Returns

{"success": true, "error": null, "data": "" }

Example copy link

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

Export
Export selected campaigns to chosen file format.


/Campaign/Export
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
campaignNamesList of stringYes
compressionFormatCompressionFormatNoApiTypes.CompressionFormat.NoneFileResponse compression format. None or Zip.
fileFormatExportFileFormatsNoApiTypes.ExportFileFormats.Csv
fileNamestringNonullName of your file.

Returns

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

Example copy link

https://api.elasticemail.com/v2/campaign/export?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&campaignNames=&fileFormat=&compressionFormat=Zip&fileName=filename.txt
Back to top

List
List all of your campaigns


/Campaign/List
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
limitintNo0Maximum of loaded items.
offsetintNo0How many items should be loaded ahead.
searchstringNonullText fragment used for searching.

Returns

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

Example copy link

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

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


/Campaign/Update
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
campaignCampaignYesJson representation of a campaign

Returns

{"success": true, "error": null, "data": { int } }

Example copy link

https://api.elasticemail.com/v2/campaign/update?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&campaign=
Back to top

Channel
SMTP and HTTP API channels for grouping email delivery.

Add
Manually add a channel to your account to group email


/Channel/Add
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
namestringYesDescriptive name of the channel

Returns

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

Example copy link

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

Delete
Delete the channel.


/Channel/Delete
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
namestringYesThe name of the channel to delete.

Returns

{"success": true, "error": null, "data": "" }

Example copy link

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

ExportCsv
Export channels in CSV file format.


/Channel/ExportCsv
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
channelNamesList of stringYes
compressionFormatCompressionFormatNoApiTypes.CompressionFormat.NoneFileResponse compression format. None or Zip.
fileNamestringNonullName of your file.

Returns

{"success": true, "error": null, "data": { Output stream containing CSV file data } }

Example copy link

https://api.elasticemail.com/v2/channel/exportcsv?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&channelNames=&compressionFormat=Zip&fileName=filename.txt
Back to top

ExportJson
Export channels in JSON file format.


/Channel/ExportJson
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
channelNamesList of stringYes
compressionFormatCompressionFormatNoApiTypes.CompressionFormat.NoneFileResponse compression format. None or Zip.
fileNamestringNonullName of your file.

Returns

{"success": true, "error": null, "data": { Output stream containing JSON file data } }

Example copy link

https://api.elasticemail.com/v2/channel/exportjson?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&channelNames=&compressionFormat=Zip&fileName=filename.txt
Back to top

ExportXml
Export channels in XML file format.


/Channel/ExportXml
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
channelNamesList of stringYes
compressionFormatCompressionFormatNoApiTypes.CompressionFormat.NoneFileResponse compression format. None or Zip.
fileNamestringNonullName of your file.

Returns

{"success": true, "error": null, "data": { Output stream containing XML file data } }

Example copy link

https://api.elasticemail.com/v2/channel/exportxml?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&channelNames=&compressionFormat=Zip&fileName=filename.txt
Back to top

List
List all of your channels


/Channel/List
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.

Returns

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

Example copy link

https://api.elasticemail.com/v2/channel/list?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3
Back to top

Update
Rename an existing channel.


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

Returns

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

Example copy link

https://api.elasticemail.com/v2/channel/update?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&name=&newName=
Back to top

Contact
Methods used to manage your Contacts.

ActivateBlocked
Activate contacts that are currently blocked.


/Contact/ActivateBlocked
Name Type Required Default Description
activateAllBlockedbooleanNofalseActivate all your blocked contacts. Passing True will override email list and activate all your blocked contacts.
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
emailsList of stringNonullComma delimited list of contact emails

Returns

{"success": true, "error": null, "data": "" }

Example copy link

https://api.elasticemail.com/v2/contact/activateblocked?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&activateAllBlocked=&emails=mail@contact.com,mail1@contact.com,mail2@contact.com
Back to top

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


/Contact/Add
Name Type Required Default Description
activationReturnUrlstringNonull
activationTemplatestringNonull
annualRevenueint?No0Annual revenue of contact
birthDatedatetime?NonullDate of birth in YYYY-MM-DD format
citystringNonullCity.
consentDatedatetime?NonullDate 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.
countrystringNonullName of country.
emailstringYesProper email address.
firstNamestringNonullFirst name.
genderstringNonullYour gender
industrystringNonullIndustry contact works in
lastNamestringNonullLast name.
listNameRepeated list of stringNonullName of your list.
mobileNumberstringNonullMobile phone number
notesstringNonullFree form field of notes
numberOfEmployeesint?No0Number of employees
organizationNamestringNonullName of organization
phonestringNonullPhone number
postalCodestringNonullZip/postal code.
publicAccountIDstringYesPublic key for limited access to your account such as contact/add so you can use it safely on public websites.
publicListIDRepeated list of stringNonullID code of list
returnUrlstringNonullURL to navigate to after account creation
sendActivationbooleanNotrueTrue, if you want to send activation email to this account. Otherwise, false
sourceContactSourceNoApiTypes.ContactSource.ContactApiSpecifies the way of uploading the contact
sourceUrlstringNonullURL from which request was sent.
statestringNonullState or province.
titlestringNonullTitle
websitestringNonullHTTP address of your website.

Returns

{"success": true, "error": null, "data": { Html string } }

Example copy link

https://api.elasticemail.com/v2/contact/add?publicAccountID=EB3EBB7A-C20D-4D39-8F2F-5E6842F58E6F&email=mail@example.com&publicListID=public-id-of-your-list&listName=My List 1&title=Mrs./Mr.&firstName=FIRSTNAME&lastName=LASTNAME&phone=1234567890&mobileNumber=1234567890&notes=Contact is extremely important!&gender=F/M&birthDate=2001-01-01&city=CITY&state=STATE&postalCode=ZIP/POSTAL&country=Canada&organizationName=ABC Inc.&website=http://example.com&annualRevenue=75000&industry=Finance&numberOfEmployees=100&source=&returnUrl=http://yourdomain.com&sourceUrl=http://source.url.com&activationReturnUrl=&activationTemplate=&sendActivation=false&consentDate=1/1/2015 0:00:00 AM&consentIP=192.168.0.1
Back to top

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


/Contact/AddBlocked
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
emailstringYesProper email address.
statusContactStatusYesName of status: Active, Engaged, Inactive, Abuse, Bounced, Unsubscribed.

Returns

{"success": true, "error": null, "data": "" }

Example copy link

https://api.elasticemail.com/v2/contact/addblocked?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&email=mail@example.com&status=Bounced
Back to top

ChangeProperty
Change any property on the contact record.


/Contact/ChangeProperty
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
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, "error": null, "data": "" }

Example copy link

https://api.elasticemail.com/v2/contact/changeproperty?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&email=mail@example.com&name=&value=
Back to top

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


/Contact/ChangeStatus
Name Type Required Default Description
allContactsbooleanNofalseTrue: Include every Contact in your Account. Otherwise, false
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
emailsList of stringNonullComma delimited list of contact emails
rulestringNonullQuery used for filtering.
statusContactStatusYesName of status: Active, Engaged, Inactive, Abuse, Bounced, Unsubscribed.

Returns

{"success": true, "error": null, "data": "" }

Example copy link

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

CountByStatus
Returns number of Contacts, RULE specifies contact Status.


/Contact/CountByStatus
Name Type Required Default Description
allContactsbooleanNofalseTrue: Include every Contact in your Account. Otherwise, false
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
rulestringNonullQuery used for filtering.

Returns

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

Example copy link

https://api.elasticemail.com/v2/contact/countbystatus?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&rule=Status%20=%20Engaged&allContacts=true/false
Back to top

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


/Contact/Delete
Name Type Required Default Description
allContactsbooleanNofalseTrue: Include every Contact in your Account. Otherwise, false
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
emailsList of stringNonullComma delimited list of contact emails
rulestringNonullQuery used for filtering.

Returns

{"success": true, "error": null, "data": "" }

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&allContacts=true/false
Back to top

Export
Export selected Contacts to JSON.


/Contact/Export
Name Type Required Default Description
allContactsbooleanNofalseTrue: Include every Contact in your Account. Otherwise, false
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
compressionFormatCompressionFormatNoApiTypes.CompressionFormat.NoneFileResponse compression format. None or Zip.
emailsList of stringNonullComma delimited list of contact emails
fileFormatExportFileFormatsNoApiTypes.ExportFileFormats.Csv
fileNamestringNonullName of your file.
rulestringNonullQuery used for filtering.

Returns

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

Example copy link

https://api.elasticemail.com/v2/contact/export?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&fileFormat=&rule=Status%20=%20Engaged&emails=mail@contact.com,mail1@contact.com,mail2@contact.com&allContacts=true/false&compressionFormat=Zip&fileName=filename.txt
Back to top

FindContact
Finds all Lists and Segments this email belongs to.


/Contact/FindContact
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
emailstringYesProper email address.

Returns

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

Example copy link

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

GetContactsByList
List of Contacts for provided List


/Contact/GetContactsByList
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
limitintNo20Maximum of loaded items.
listNamestringYesName of your list.
offsetintNo0How many items should be loaded ahead.

Returns

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

Example copy link

https://api.elasticemail.com/v2/contact/getcontactsbylist?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&listName=My List 1&limit=100&offset=20
Back to top

GetContactsBySegment
List of Contacts for provided Segment


/Contact/GetContactsBySegment
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
limitintNo20Maximum of loaded items.
offsetintNo0How many items should be loaded ahead.
segmentNamestringYesName of your segment.

Returns

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

Example copy link

https://api.elasticemail.com/v2/contact/getcontactsbysegment?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&segmentName=My Segment 1&limit=100&offset=20
Back to top

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


/Contact/List
Name Type Required Default Description
allContactsbooleanNofalseTrue: Include every Contact in your Account. Otherwise, false
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
limitintNo20Maximum of loaded items.
offsetintNo0How many items should be loaded ahead.
rulestringNonullQuery used for filtering.

Returns

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

Example copy link

https://api.elasticemail.com/v2/contact/list?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&rule=Status%20=%20Engaged&allContacts=true/false&limit=100&offset=20
Back to top

LoadBlocked
Load blocked contacts


/Contact/LoadBlocked
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
limitintNo0Maximum of loaded items.
offsetintNo0How many items should be loaded ahead.
searchstringYesText fragment used for searching.
statusContactStatus?NonullName of blocked status: Abuse, Bounced or Unsubscribed

Returns

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

Example copy link

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

LoadContact
Load detailed contact information


/Contact/LoadContact
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
emailstringYesProper email address.

Returns

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

Example copy link

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

LoadHistory
Shows detailed history of chosen Contact.


/Contact/LoadHistory
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
emailstringYesProper email address.
limitintNo0Maximum of loaded items.
offsetintNo0How many items should be loaded ahead.

Returns

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

Example copy link

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

QuickAdd
Add new Contact to one of your Lists.


/Contact/QuickAdd
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
citystringNonullCity.
consentDatedatetime?NonullDate 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.
countrystringNonullName of country.
emailsList of stringYesComma delimited list of contact emails
firstNamestringNonullFirst name.
industrystringNonullIndustry contact works in
lastNamestringNonullLast name.
listNamestringNonullName of your list.
notesstringNonullFree form field of notes
organizationstringNonullName of organization
publicListIDstringNonullID code of list
statestringNonullState or province.
statusContactStatusNoApiTypes.ContactStatus.ActiveName of status: Active, Engaged, Inactive, Abuse, Bounced, Unsubscribed.
titlestringNonullTitle
zipstringNonullZip/postal code.

Returns

{"success": true, "error": null, "data": "" }

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=FIRSTNAME&lastName=LASTNAME&title=Mrs./Mr.&organization=ABC Inc.&industry=Finance&city=CITY&country=Canada&state=STATE&zip=ZIP/POSTAL&publicListID=public-id-of-your-list&listName=My List 1&status=Bounced&notes=Contact is extremely important!&consentDate=1/1/2015 0:00:00 AM&consentIP=192.168.0.1
Back to top

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


/Contact/Update
Name Type Required Default Description
activatestringNonullTrue, if Contact should be activated. Otherwise, false
annualRevenuestringNonullAnnual revenue of contact
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
birthDatestringNonullDate of birth in YYYY-MM-DD format
citystringNonullCity.
clearRestOfFieldsbooleanNotrue
countrystringNonullName of country.
emailstringYesProper email address.
faxNumberstringNonullFax number
firstNamestringNonullFirst name.
firstPurchasestringNonullDate of first purchase in YYYY-MM-DD format
genderstringNonullYour gender
industrystringNonullIndustry contact works in
lastNamestringNonullLast name.
lastPurchasestringNonullDate of last purchase in YYYY-MM-DD format
linkedInBiostringNonullBiography for Linked-In
linkedInConnectionsintNo0Number of Linked-In connections
mobileNumberstringNonullMobile phone number
newEmailstringNonullNew email address.
notesstringNonullFree form field of notes
numberOfEmployeesintNo0Number of employees
organizationNamestringNonullName of organization
pageViewsintNo0Number of page views
phonestringNonullPhone number
purchaseCountintNo0Number of purchases contact has made
statestringNonullState or province.
titlestringNonullTitle
twitterBiostringNonullBiography for Twitter
twitterFollowerCountintNo0Number of Twitter followers
twitterProfilePhotostringNonullURL for Twitter photo
twitterUsernamestringNonullUser name for Twitter
visitsintNo0Number of website visits
websiteUrlstringNonullWebsite of contact
zipstringNonullZip/postal code.

Returns

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

Example copy link

https://api.elasticemail.com/v2/contact/update?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&email=mail@example.com&newEmail=newmail@example.com&firstName=FIRSTNAME&lastName=LASTNAME&organizationName=ABC Inc.&title=Mrs./Mr.&city=CITY&state=STATE&country=Canada&zip=ZIP/POSTAL&birthDate=2001-01-01&gender=F/M&phone=1234567890&activate=false&industry=Finance&numberOfEmployees=100&annualRevenue=75000&purchaseCount=2&firstPurchase=2014-01-01&lastPurchase=2015-01-01&notes=Contact is extremely important!&websiteUrl=http://&mobileNumber=1234567890&faxNumber=1234567890&linkedInBio=Short biography for Link-In Profile&linkedInConnections=50&twitterBio=Short biography for Twitter Profile&twitterUsername=@elastic_email&twitterProfilePhoto=http://&twitterFollowerCount=50&pageViews=50&visits=100&clearRestOfFields=
Back to top

Upload
Upload contacts in CSV file.


/Contact/Upload
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
consentDatedatetime?NonullDate 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.
listIDintYesID number of selected list.
statusContactStatusNoApiTypes.ContactStatus.ActiveName of status: Active, Engaged, Inactive, Abuse, Bounced, Unsubscribed.

Attach the file as POST multipart/form-data file upload or PUT file upload with content-disposition header

Returns

{"success": true, "error": null, "data": { int } }

Example copy link

https://api.elasticemail.com/v2/contact/upload?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&listID=1234&status=Bounced&consentDate=1/1/2015 0:00:00 AM&consentIP=192.168.0.1
Back to top

Domain
Managing sender domains. Creating new entries and validating domain records.

Add
Add new domain to account


/Domain/Add
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
domainstringYesName of selected domain.

Returns

{"success": true, "error": null, "data": "" }

Example copy link

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

Delete
Deletes configured domain from account


/Domain/Delete
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
domainstringYesName of selected domain.

Returns

{"success": true, "error": null, "data": "" }

Example copy link

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

List
Lists all domains configured for this account.


/Domain/List
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.

Returns

{"success": true, "error": null, "data": { List of DomainDetail } }

Example copy link

https://api.elasticemail.com/v2/domain/list?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3
Back to top

SetDefault
Verification of email addres set for domain.


/Domain/SetDefault
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
domainstringYesDefault email sender, example: mail@yourdomain.com

Returns

{"success": true, "error": null, "data": "" }

Example copy link

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

VerifyDkim
Verification of DKIM record for domain


/Domain/VerifyDkim
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
domainstringYesName of selected domain.

Returns

{"success": true, "error": null, "data": "" }

Example copy link

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

VerifyMX
Verification of MX record for domain


/Domain/VerifyMX
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
domainstringYesName of selected domain.

Returns

{"success": true, "error": null, "data": "" }

Example copy link

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

VerifySpf
Verification of SPF record for domain


/Domain/VerifySpf
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
domainstringYesName of selected domain.

Returns

{"success": true, "error": null, "data": "" }

Example copy link

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

VerifyTracking
Verification of tracking CNAME record for domain


/Domain/VerifyTracking
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
domainstringYesName of selected domain.

Returns

{"success": true, "error": null, "data": "" }

Example copy link

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

Email

GetStatus
Get email batch status


/Email/GetStatus
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
showAbusebooleanNofalseInclude Reported as abuse email addresses.
showClickedbooleanNofalseInclude Clicked email addresses.
showDeliveredbooleanNofalseInclude Sent 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.
showUnsubscribedbooleanNofalseInclude Unsubscribed email addresses.
transactionIDstringYesTransaction identifier

Returns

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

Example copy link

https://api.elasticemail.com/v2/email/getstatus?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&transactionID=&showFailed=&showDelivered=&showPending=&showOpened=&showClicked=&showAbuse=&showUnsubscribed=&showErrors=&showMessageIDs=
Back to top

Send
Submit emails. 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/


/Email/Send
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
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ā€¦
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)
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
headers_customheadernameRepeated 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_customheader1=customheader1: header-value1 headers_customheader2 = customheader2: header-value2
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.
msgBccRepeated list 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.
msgCCRepeated list 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.
msgToRepeated list 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 name of an email template you have created in your account.
timeOffSetMinutesstringNonullNumber of minutes in the future this email should be sent
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.

Attach the file as POST multipart/form-data file upload

Returns

{"success": true, "error": null, "data": { EmailSend } }

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=&channel=&bodyHtml=&bodyText=&charset=&charsetBodyHtml=&charsetBodyText=&encodingType=&template=&headers_customheadername=&postBack=&merge=&timeOffSetMinutes=&poolName=My Custom Pool&isTransactional=false
Back to top

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.


/Email/Status
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
messageIDstringYesUnique identifier for this email.

Returns

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

Example copy link

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

View
View email


/Email/View
Name Type Required Default Description
messageIDstringYesMessage identifier

Returns

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

Example copy link

https://api.elasticemail.com/v2/email/view?messageID=
Back to top

Export

CheckStatus
Check the current status of the export.


/Export/CheckStatus
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
publicExportIDGUIDYes

Returns

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

Example copy link

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

CountByType
Summary of export type counts.


/Export/CountByType
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.

Returns

{"success": true, "error": null, "data": { ExportTypeCounts } }

Example copy link

https://api.elasticemail.com/v2/export/countbytype?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3
Back to top

Delete
Delete the specified export.


/Export/Delete
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
publicExportIDGUIDYes

Returns

{"success": true, "error": null, "data": "" }

Example copy link

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

List
Returns a list of all exported data.


/Export/List
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
limitintNo0Maximum of loaded items.
offsetintNo0How many items should be loaded ahead.

Returns

{"success": true, "error": null, "data": { List of Export } }

Example copy link

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

List
API methods for managing your Lists

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


/List/Add
Name Type Required Default Description
allContactsbooleanNofalseTrue: Include every Contact in your Account. Otherwise, false
allowUnsubscribebooleanNofalseTrue: Allow unsubscribing from this list. Otherwise, false
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
createEmptyListbooleanNofalseTrue to create an empty list, otherwise false. Ignores rule and emails parameters if provided.
emailsList of stringNonullComma delimited list of contact emails
listNamestringYesName of your list.
rulestringNonullQuery used for filtering.

Returns

{"success": true, "error": null, "data": { int } }

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
Back to top

AddContacts
Add Contacts to chosen list


/List/AddContacts
Name Type Required Default Description
allContactsbooleanNofalseTrue: Include every Contact in your Account. Otherwise, false
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
emailsList of stringNonullComma delimited list of contact emails
listNamestringYesName of your list.
rulestringNonullQuery used for filtering.

Returns

{"success": true, "error": null, "data": "" }

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
Back to top

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


/List/Copy
Name Type Required Default Description
allowUnsubscribeboolean?NonullTrue: Allow unsubscribing from this list. Otherwise, false
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
createEmptyListboolean?NonullTrue 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.
sourceListNamestringYesThe name of the list you want to copy

Returns

{"success": true, "error": null, "data": { int } }

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
Back to top

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


/List/CreateFromCampaign
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
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, "error": null, "data": { int } }

Example copy link

https://api.elasticemail.com/v2/list/createfromcampaign?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&campaignID=&listName=My List 1&statuses=
Back to top

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


/List/CreateNthSelectionLists
Name Type Required Default Description
allContactsbooleanNofalseTrue: Include every Contact in your Account. Otherwise, false
allowUnsubscribebooleanNofalseTrue: Allow unsubscribing from this list. Otherwise, false
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
excludeBlockedbooleanNotrueTrue if you want to exclude contacts that are currently in a blocked status of either unsubscribe, complaint or bounce. Otherwise, false.
listNamestringYesName of your list.
numberOfListsintYesThe number of evenly distributed lists to create.
rulestringNonullQuery used for filtering.

Returns

{"success": true, "error": null, "data": "" }

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
Back to top

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


/List/CreateRandomList
Name Type Required Default Description
allContactsbooleanNofalseTrue: Include every Contact in your Account. Otherwise, false
allowUnsubscribebooleanNofalseTrue: Allow unsubscribing from this list. Otherwise, false
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
countintYesNumber of items.
excludeBlockedbooleanNotrueTrue if you want to exclude contacts that are currently in a blocked status of either unsubscribe, complaint or bounce. Otherwise, false.
listNamestringYesName of your list.
rulestringNonullQuery used for filtering.

Returns

{"success": true, "error": null, "data": { int } }

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
Back to top

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


/List/Delete
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
listNamestringYesName of your list.

Returns

{"success": true, "error": null, "data": "" }

Example copy link

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

Export
Exports all the contacts from the provided list


/List/Export
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
compressionFormatCompressionFormatNoApiTypes.CompressionFormat.NoneFileResponse compression format. None or Zip.
fileFormatExportFileFormatsNoApiTypes.ExportFileFormats.Csv
fileNamestringNonullName of your file.
listNamestringYesName of your list.

Returns

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

Example copy link

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

list
Shows all your existing lists


/List/list
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
fromdatetime?NonullStarting date for search in YYYY-MM-DDThh:mm:ss format.
todatetime?NonullEnding date for search in YYYY-MM-DDThh:mm:ss format.

Returns

{"success": true, "error": null, "data": { List of List } }

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
Back to top

Load
Returns detailed information about specific list.


/List/Load
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
listNamestringYesName of your list.

Returns

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

Example copy link

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

MoveContacts
Move selected contacts from one List to another


/List/MoveContacts
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
emailsList of stringYesComma delimited list of contact emails
newListNamestringYesThe name of the list to copy the contacts to
oldListNamestringYesThe name of the list from which the contacts will be copied from

Returns

{"success": true, "error": null, "data": "" }

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
Back to top

RemoveContacts
Remove selected Contacts from your list


/List/RemoveContacts
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
emailsList of stringNonullComma delimited list of contact emails
listNamestringYesName of your list.
rulestringNonullQuery used for filtering.

Returns

{"success": true, "error": null, "data": "" }

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
Back to top

Update
Update existing list


/List/Update
Name Type Required Default Description
allowUnsubscribebooleanYesTrue: Allow unsubscribing from this list. Otherwise, false
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
listNamestringYesName of your list.
newListNamestringYesName of your list if you want to change it.

Returns

{"success": true, "error": null, "data": "" }

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
Back to top

Log
Methods to check logs of your campaigns

CancelInProgress
Cancels emails that are waiting to be sent.


/Log/CancelInProgress
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
channelNamestringNonullName of selected channel.
transactionIDstringNonullID number of transaction

Returns

{"success": true, "error": null, "data": "" }

Example copy link

https://api.elasticemail.com/v2/log/cancelinprogress?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&channelName=Channel01&transactionID=TransactionID
Back to top

Export
Export email log information to the specified file format.


/Log/Export
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
channelIDintNo0ID number of selected Channel.
compressionFormatCompressionFormatNoApiTypes.CompressionFormat.NoneFileResponse compression format. None or Zip.
emailstringNonullProper email address.
fileFormatExportFileFormatsNoApiTypes.ExportFileFormats.Csv
fileNamestringNonullName of your file.
fromdatetime?NonullStart date.
includeEmailbooleanNotrueTrue: Search includes emails. Otherwise, false.
includeSmsbooleanNotrueTrue: Search includes SMS. Otherwise, false.
limitintNo0Maximum of loaded items.
messageCategoryList of MessageCategoryNonullID of message category
offsetintNo0How many items should be loaded ahead.
statusesList of LogJobStatusYesList of comma separated message statuses: 0 or 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
todatetime?NonullEnd date.

Returns

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

Example copy link

https://api.elasticemail.com/v2/log/export?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&statuses=0&fileFormat=&from=&to=&channelID=123456&limit=100&offset=20&includeEmail=true/false&includeSms=true/false&messageCategory=1&compressionFormat=Zip&fileName=filename.txt&email=mail@example.com
Back to top

ExportLinkTracking
Export detailed link tracking information to the specified file format.


/Log/ExportLinkTracking
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
channelIDintYesID number of selected Channel.
compressionFormatCompressionFormatNoApiTypes.CompressionFormat.NoneFileResponse compression format. None or Zip.
fileFormatExportFileFormatsNoApiTypes.ExportFileFormats.Csv
fileNamestringNonullName of your file.
fromdatetime?YesStart date.
limitintNo0Maximum of loaded items.
offsetintNo0How many items should be loaded ahead.
todatetime?YesEnd Date.

Returns

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

Example copy link

https://api.elasticemail.com/v2/log/exportlinktracking?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&channelID=123456&from=&to=&fileFormat=&limit=100&offset=20&compressionFormat=Zip&fileName=filename.txt
Back to top

LinkTracking
Track link clicks


/Log/LinkTracking
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
channelNamestringNonullName of selected channel.
fromdatetime?NonullStarting date for search in YYYY-MM-DDThh:mm:ss format.
limitintNo0Maximum of loaded items.
offsetintNo0How many items should be loaded ahead.
todatetime?NonullEnding date for search in YYYY-MM-DDThh:mm:ss format.

Returns

{"success": true, "error": null, "data": { LinkTrackingDetails } }

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
Back to top

Load
Returns logs filtered by specified parameters.


/Log/Load
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
channelNamestringNonullName of selected channel.
emailstringNonullProper email address.
fromdatetime?NonullStarting date for search in YYYY-MM-DDThh:mm:ss format.
includeEmailbooleanNotrueTrue: Search includes emails. Otherwise, false.
includeSmsbooleanNotrueTrue: Search includes SMS. Otherwise, false.
limitintNo0Maximum of loaded items.
messageCategoryList of MessageCategoryNonullID of message category
offsetintNo0How many items should be loaded ahead.
statusesList of LogJobStatusYesList of comma separated message statuses: 0 or 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
todatetime?NonullEnding date for search in YYYY-MM-DDThh:mm:ss format.

Returns

{"success": true, "error": null, "data": { Log } }

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
Back to top

RetryNow
Retry sending of temporarily not delivered message.


/Log/RetryNow
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
msgIDstringYesID number of selected message.

Returns

{"success": true, "error": null, "data": "" }

Example copy link

https://api.elasticemail.com/v2/log/retrynow?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&msgID=MessageID
Back to top

Summary
Loads summary information about activity in chosen date range.


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

Returns

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

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
Back to top

Segment
Manages your segments - dynamically created lists of contacts

Add
Create new segment, based on specified RULE.


/Segment/Add
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
rulestringYesQuery used for filtering.
segmentNamestringYesName of your segment.

Returns

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

Example copy link

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

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


/Segment/Copy
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
newSegmentNamestringNonullNew name of your segment if you want to change it.
rulestringNonullQuery used for filtering.
sourceSegmentNamestringYesThe name of the segment you want to copy

Returns

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

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
Back to top

Delete
Delete existing segment.


/Segment/Delete
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
segmentNamestringYesName of your segment.

Returns

{"success": true, "error": null, "data": "" }

Example copy link

https://api.elasticemail.com/v2/segment/delete?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&segmentName=My Segment 1
Back to top

Export
Exports all the contacts from the provided segment


/Segment/Export
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
compressionFormatCompressionFormatNoApiTypes.CompressionFormat.NoneFileResponse compression format. None or Zip.
fileFormatExportFileFormatsNoApiTypes.ExportFileFormats.Csv
fileNamestringNonullName of your file.
segmentNamestringYesName of your segment.

Returns

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

Example copy link

https://api.elasticemail.com/v2/segment/export?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&segmentName=My Segment 1&fileFormat=&compressionFormat=Zip&fileName=filename.txt
Back to top

List
Lists all your available Segments


/Segment/List
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
fromdatetime?NonullFrom what date should the segment history be shown
includeHistorybooleanNofalseTrue: Include history of last 30 days. Otherwise, false.
todatetime?NonullTo what date should the segment history be shown

Returns

{"success": true, "error": null, "data": { List of Segment } }

Example copy link

https://api.elasticemail.com/v2/segment/list?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&includeHistory=true/false&from=&to=
Back to top

Update
Rename or change RULE for your segment


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

Returns

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

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
Back to top

SMS
Managing texting to your clients.

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


/SMS/Send
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
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 message 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, "error": null, "data": "" }

Example copy link

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

Survey
Methods to organize and get results of your surveys

Add
Adds a new survey


/Survey/Add
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
surveySurveyYesJson representation of a survey

Returns

{"success": true, "error": null, "data": { Survey } }

Example copy link

https://api.elasticemail.com/v2/survey/add?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&survey=
Back to top

Delete
Deletes the survey


/Survey/Delete
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
publicSurveyIDGUIDYesSurvey identifier

Returns

{"success": true, "error": null, "data": "" }

Example copy link

https://api.elasticemail.com/v2/survey/delete?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&publicSurveyID=123456
Back to top

Export
Export given survey's data to provided format


/Survey/Export
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
compressionFormatCompressionFormatNoApiTypes.CompressionFormat.NoneFileResponse compression format. None or Zip.
fileFormatExportFileFormatsNoApiTypes.ExportFileFormats.Csv
fileNamestringYesName of your file.
publicSurveyIDGUIDYesSurvey identifier

Returns

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

Example copy link

https://api.elasticemail.com/v2/survey/export?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&publicSurveyID=123456&fileName=filename.txt&fileFormat=&compressionFormat=Zip
Back to top

List
Shows all your existing surveys


/Survey/List
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.

Returns

{"success": true, "error": null, "data": { List of Survey } }

Example copy link

https://api.elasticemail.com/v2/survey/list?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3
Back to top

LoadResponseList
Get list of personal answers for the specific survey


/Survey/LoadResponseList
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
publicSurveyIDGUIDYesSurvey identifier

Returns

{"success": true, "error": null, "data": { List of SurveyResultInfo } }

Example copy link

https://api.elasticemail.com/v2/survey/loadresponselist?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&publicSurveyID=123456
Back to top

LoadResults
Get general results of the specific survey


/Survey/LoadResults
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
publicSurveyIDGUIDYesSurvey identifier

Returns

{"success": true, "error": null, "data": { SurveyResultsSummaryInfo } }

Example copy link

https://api.elasticemail.com/v2/survey/loadresults?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&publicSurveyID=123456
Back to top

Update
Update the survey information


/Survey/Update
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
surveySurveyYesJson representation of a survey

Returns

{"success": true, "error": null, "data": { Survey } }

Example copy link

https://api.elasticemail.com/v2/survey/update?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&survey=
Back to top

Template
Managing and editing templates of your emails

Add
Create new Template. Needs to be sent using POST method


/Template/Add
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
bodyHtmlstringNonullHTML code of email (needs escaping).
bodyTextstringNonullText body of email.
cssstringNonullCSS style
fromEmailstringYesDefault From: email address.
fromNamestringYesDefault From: name.
originalTemplateIDintNo0ID number of original template.
subjectstringYesDefault subject of email.
templateNamestringYesName of template.
templateScopeTemplateScopeNoApiTypes.TemplateScope.PrivateEnum: 0 - private, 1 - public, 2 - mockup
templateTypeTemplateTypeYes0 for API connections

Returns

{"success": true, "error": null, "data": { int } }

Example copy link

https://api.elasticemail.com/template/add?version=2
Back to top

CheckUsage
Check if template is used by campaign.


/Template/CheckUsage
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
templateIDintYesID number of template.

Returns

{"success": true, "error": null, "data": { boolean } }

Example copy link

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

Copy
Copy Selected Template


/Template/Copy
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
fromEmailstringYesDefault From: email address.
fromNamestringYesDefault From: name.
subjectstringYesDefault subject of email.
templateIDintYesID number of template.
templateNamestringYesName of template.

Returns

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

Example copy link

https://api.elasticemail.com/v2/template/copy?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&templateID=1234&templateName=Template01&subject=Hello!&fromEmail=sender@yourdomain.com&fromName=Sender
Back to top

Delete
Delete template with the specified ID


/Template/Delete
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
templateIDintYesID number of template.

Returns

{"success": true, "error": null, "data": "" }

Example copy link

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

GetEmbeddedHtml
Search for references to images and replaces them with base64 code.


/Template/GetEmbeddedHtml
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
templateIDintYesID number of template.

Returns

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

Example copy link

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

GetList
Lists your templates


/Template/GetList
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
limitintNo500Maximum of loaded items.
offsetintNo0How many items should be loaded ahead.

Returns

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

Example copy link

https://api.elasticemail.com/v2/template/getlist?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&limit=100&offset=20
Back to top

LoadTemplate
Load template with content


/Template/LoadTemplate
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
ispublicbooleanNofalse
templateIDintYesID number of template.

Returns

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

Example copy link

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

RemoveScreenshot
Removes previously generated screenshot of template


/Template/RemoveScreenshot
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
templateIDintYesID number of template.

Returns

{"success": true, "error": null, "data": "" }

Example copy link

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

SaveScreenshot
Saves screenshot of chosen Template


/Template/SaveScreenshot
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
base64ImagestringYesImage, base64 coded.
templateIDintYesID number of template.

Returns

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

Example copy link

https://api.elasticemail.com/v2/template/savescreenshot?apikey=94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3&base64Image=&templateID=1234
Back to top

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


/Template/Update
Name Type Required Default Description
apikeystringYesApiKey that gives you access to our SMTP and HTTP API's.
bodyHtmlstringNonullHTML code of email (needs escaping).
bodyTextstringNonullText body of email.
cssstringNonullCSS style
fromEmailstringNonullDefault From: email address.
fromNamestringNonullDefault From: name.
removeScreenshotbooleanNotrue
subjectstringNonullDefault subject of email.
templateIDintYesID number of template.
templateNamestringNonullName of template.
templateScopeTemplateScopeNoApiTypes.TemplateScope.PrivateEnum: 0 - private, 1 - public, 2 - mockup

Returns

{"success": true, "error": null, "data": "" }

Example copy link

https://api.elasticemail.com/template/update?version=2
Back to top

Classes
Classes used in Elastic Email API

Account
Detailed information about your account


PropertiesDescriptionExampleType
AccountPaymentUrl URL for making payments.http://payments.yourdomain.comstring
AccountType Type of account: 1 for Transactional Email, 2 for Marketing Email.2AccountType
Address1 First line of address.ADDRESS1string
Address2 Second line of address.ADDRESS2string
AffiliateLink URL for affiliating.http://string
ApiKey ApiKey that gives you access to our SMTP and HTTP API's.94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3string
ApiKey2 Second ApiKey that gives you access to our SMTP and HTTP API's. Used mainly for changing ApiKeys without disrupting services.BE4C7ECC-5176-44B4-A843-EE704BCB1B51string
AutoCreditAmount When AutoCreditStatus is Enabled, the amount of credit to be recharged.500decimal
AutoCreditLevel When AutoCreditStatus is Enabled, the credit level that triggers the credit to be recharged.100decimal
AutoCreditStatus Status of automatic payments configuration.neverenabledstring
City City.CITYstring
Company Company name.COMPANYstring
ContentTransferEncoding Type of content encodingBase64string
CountryID Numeric ID of country. A file with the list of countries is available here12345int?
Credit Amount of emails sent from this account1000decimal
DailySendLimit Amount of emails account can send daily100000int
DateCreated Creation date.2001-01-01:12:00:00datetime
DeliveryReason Why your clients are receiving your emails.Reasonstring
Email Proper email address.mail@example.comstring
EmailCredits Amount of email credits1000int
EnableContactFeatures Enable advanced tools on your Account.boolean
EnablePrivateBranding True: Turn on or off ability to send mails under your brand. Otherwise, falsetrueboolean
FirstName First name.FIRSTNAMEstring
IsSub True, if account is a subaccount. Otherwise, falsefalseboolean
LastName Last name.LASTNAMEstring
LinkTracking True, if you have enabled link tracking. Otherwise, falsetrueboolean
LitmusCredits Amount of Litmus credits1000decimal
LogoUrl URL to your logo image.http://yourdomain.com/logo.pngstring
MonthlyEmailsSent Amount of emails sent from this account1000long?
NeedsSMSVerification boolean
PaymentFormUrl URL form for payments.http://string
Phone Phone number1234567890string
PricePerEmail Amount of emails sent from this account1000decimal
PrivateBrandingUrl Subdomain for your rebranded servicemailing.yourdomain.comstring
PublicAccountID Public key for limited access to your account such as contact/add so you can use it safely on public websites.EB3EBB7A-C20D-4D39-8F2F-5E6842F58E6Fstring
Reputation Numeric reputation100double
Smtp Address of SMTP server.smtp.yourdomain.comstring
SmtpAlternative Address of alternative SMTP server.smtp2.yourdomain.comstring
State State or province.STATEstring
StatusFormatted Account status: ActiveActivestring
StatusNumber Number of status: 1 - Active1int
SubAccountsCount The number of subaccounts this account has.1long
SupportLink Address to your support.http://help.yourdomain.comstring
TaxCode Code used for tax purposes.string
TotalEmailsSent Amount of emails sent from this account1000long
Website HTTP address of your website.http://example.comstring
Zip Zip/postal code.ZIP/POSTALstring
Back to top

AccountOverview
Basic overview of your account


PropertiesDescriptionExampleType
BlockedContactsCount Number of contacts currently with blocked status of Unsubscribed, Complaint, Bounced or InActive1000long
CampaignCount Number of created campaigns10long
ContactCount Number of contacts10000long
CostPerThousand Cost of 1000 emails0.09decimal
Credit Amount of emails sent from this account1000decimal
InProgressCount Number of messages in progress1234long
ReferralCount Number of active referrals10long
Reputation Numeric reputation100double
SubAccountCount Number of created subaccounts10long
TemplateCount Number of available templates10long
TotalEmailsSent Amount of emails sent from this account1000long
Back to top

AccountType Enumeration


ValuesValueDescription
Marketing 2Account is used for sending bulk marketing email
Transactional 1Account is used for sending transactional mail only.
Back to top

AdvancedOptions
Lists advanced sending options of your account.


PropertiesDescriptionExampleType
AllowCustomHeaders True, if you want to apply custom headers to your emails. Otherwise, falsetrueboolean
AutoTextFormat True, if text BODY of message should be created automatically. Otherwise, falsetrueboolean
BccEmail Email address to send a copy of all email to.your@email.comstring
ContentTransferEncoding Type of content encodingBase64string
EmailNotification True, if you want to receive bounce email notifications. Otherwise, falsetruestring
EmailNotificationForError True, if you want bounce notifications returned. Otherwise, falsefalseboolean
EnableClickTracking True, if you want to track clicks. Otherwise, falsetrueboolean
EnableContactFeatures True, if you want to use Advanced Tools. Otherwise, falseboolean
EnableLinkClickTracking True, if you want to track by link tracking. Otherwise, falsetrueboolean
EnableUITooltips True, if account has tooltips active. Otherwise, falsetrueboolean
EnableUnsubscribeHeader True, if you want to enable list-unsubscribe header. Otherwise, falsetrueboolean
HubCallbackUrl URL used for tracking action of inbound emailshttp://string
InboundContactsOnly True, if you want inbound email to only process contacts from your account. Otherwise, falsetrueboolean
InboundDomain Domain you use as your inbound domainyourdomain.comstring
IsOwnedByReseller True, if this account resells Elastic Email. Otherwise, false.falseboolean
IsSubAccount True, if this account is a sub-account. Otherwise, falsetrueboolean
LogoUrl URL to your logo image.http://yourdomain.com/logo.pngstring
LowCreditNotification True, if you want to receive low credit email notifications. Otherwise, falsetrueboolean
ManageSubscribedOnly True, if you want to only display labels that the contact is subscribed to on your unsubscribe form. Otherwise, falsetrueboolean
ManageSubscriptions True, if you want to display your labels on your unsubscribe form. Otherwise, falsetrueboolean
NotificationsEmails Email addresses to send a copy of all notifications from our system. Separated by semicolonemail1@example.com;email2@example.comstring
PreviewMessageID string
TransactionalOnUnsubscribe True, if you want to display an option for the contact to opt into transactional email only on your unsubscribe form. Otherwise, falsetrueboolean
WebNotificationForAbuse True, if you want to send web notifications for complaint email. Otherwise, falsetrueboolean
WebNotificationForClicked True, if you want to send web notifications for clicked email. Otherwise, falsetrueboolean
WebNotificationForError True, if you want to send web notifications for bounced email. Otherwise, falsetrueboolean
WebNotificationForOpened True, if you want to send web notifications for opened email. Otherwise, falsetrueboolean
WebNotificationForSent True, if you want to send web notifications for sent email. Otherwise, falsetrueboolean
WebnotificationForUnsubscribed True, if you want to send web notifications for unsubscribed email. Otherwise, falsetrueboolean
WebNotificationUrl URL address to receive web notifications to parse and process.http://string
Back to top

APIKeyAction Enumeration


ValuesValueDescription
Add 1Add an additional APIKey to your Account.
Change 2Change this APIKey to a new one.
Delete 3Delete this APIKey
Back to top

Attachment
Attachment data


PropertiesDescriptionExampleType
FileName Name of your file.filename.txtstring
ID ID number of your attachment123456string
Size Size of your attachment.100int
Back to top

BlockedContact
Blocked Contact - Contact returning Hard Bounces


PropertiesDescriptionExampleType
DateUpdated Last change date2001-01-01:12:00:00string
Email Proper email address.mail@example.comstring
FriendlyErrorMessage RFC error messageMailbox not foundstring
Status Name of status: Active, Engaged, Inactive, Abuse, Bounced, Unsubscribed.Bouncedstring
Back to top

BouncedCategorySummary
Summary of bounced categories, based on specified date range.


PropertiesDescriptionExampleType
AccountProblem Number of messages flagged with 'Account Problem'0long
BlackListed Number of blacklisted messages1000long
CodeError Number of messages flagged with 'Code Error'0long
ConnectionProblem Number of messages flagged with 'Connection Problem'0long
ConnectionTerminated Number of messages flagged with 'Connection terminated'0long
DnsProblem Number of messages flagged with 'DNS Problem'0long
GreyListed Number of messages flagged with 'Grey Listed'0long
ManualCancel Number of manually cancelled messages1000long
NoMailbox Number of messages flagged with 'No Mailbox'0long
NotDelivered Number of messages flagged with 'Not Delivered'0long
Spam Number of messages marked as SPAM1000long
SpfProblem Number of messages flagged with 'SPF Problem'0long
Throttled Number of messages flagged with 'Throttled'0long
Timeout Number of messages flagged with 'Timeout'0long
WhitelistingProblem Number of messages flagged with 'WhiteListing Problem'0long
Back to top

Campaign
Campaign


PropertiesDescriptionExampleType
CampaignTemplates List of CampaignTemplate
ChannelID ID number of selected Channel.123456int?
Name Campaign's namestring
SplitOptimization What should be checked for choosing the winner: opens or clicks0SplitOptimization
SplitOptimizationMinutes Number of minutes between sends during optimization period30int
Status Name of campaign's statusCampaignStatus
Targets List of Segment and List IDs, comma separateds01,l10Repeated list of string
TriggerChannelID ID number of transactionTransactionIDint
TriggerCount Date of send2001-01-01T12:00:00int
TriggerData Data for filtering event campaigns such as specific link addresses.http://elasticemail.comstring
TriggerDate Date of triggered send2001-01-01T12:00:00datetime?
TriggerDelay How far into the future should the campaign be sent, in minutes20double
TriggerFrequency When your next automatic mail will be sent, in days30double
TriggerType Number of event, triggering mail sending1CampaignTriggerType
Back to top

CampaignChannel
Channel


PropertiesDescriptionExampleType
ChannelID ID number of selected Channel.123456int
ClickedCount Total emails clicked1000int
DateAdded Date of creation in YYYY-MM-DDThh:ii:ss format2001-01-01T12:00:00datetime
FailedAbuse Abuses - mails sent to user without their consent0.00int
FailedCount Total emails sent.1000int
IsCampaign True, if you are sending a campaign. Otherwise, false.Trueboolean
LastActivity Date of last activity on account2001-01-01T12:00:00datetime?
LastProcessed Datetime of last action done on campaign.2001-01-01T01:01:01datetime?
Name Filenameattachment.txtstring
OpenedCount Total emails opened.1000int
ParentChannelID Id number of parent channel123456int
PoolName Name of your custom IP Pool to be used in the sending processMy Custom Poolstring
RecipientCount Overall number of recipients1000int
SentCount Total emails sent.1000int
SplitOptimization What should be checked for choosing the winner: opens or clicks0SplitOptimization
SplitOptimizationMinutes Number of minutes between sends during optimization period30int
Status Name of campaign's statusCampaignStatus
Targets List of Segment and List IDs, comma separateds01,l10Repeated list of string
TemplateChannels List of CampaignTemplate for sending A-X split testing.CampaignTemplate1, CampaignTemplate2List of CampaignChannel
TemplateFromEmail Default From: email address.sender@yourdomain.comstring
TemplateFromName Default From: name.Senderstring
TemplateID ID number of template.1234int?
TemplateReplyEmail Default Reply: email address.replyto@yourdomain.comstring
TemplateReplyName Default Reply: name.Replystring
TemplateSubject Default subject of email.Hello!string
TriggerChannelID ID number of transactionTransactionIDint
TriggerCount Date of send2001-01-01T12:00:00int
TriggerData Data for filtering event campaigns such as specific link addresses.http://elasticemail.comstring
TriggerDate Date of triggered send2001-01-01T12:00:00datetime?
TriggerDelay How far into the future should the campaign be sent, in minutes20double
TriggerFrequency When your next automatic mail will be sent, in days30double
TriggerType Number of event, triggering mail sending1CampaignTriggerType
UnsubscribedCount Total emails clicked1000int
Back to top

CampaignStatus Enumeration


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

CampaignTemplate


PropertiesDescriptionExampleType
ChannelID ID number of selected Channel.123456int?
PoolName Name of your custom IP Pool to be used in the sending processMy Custom Poolstring
Status Name of campaign's statusCampaignStatus
TemplateFromEmail Default From: email address.sender@yourdomain.comstring
TemplateFromName Default From: name.Senderstring
TemplateID ID number of template.1234int?
TemplateReplyEmail Default Reply: email address.replyto@yourdomain.comstring
TemplateReplyName Default Reply: name.Replystring
TemplateSubject Default subject of email.Hello!string
Back to top

CampaignTriggerType Enumeration


ValuesValueDescription
FutureScheduled 2
OnAdd 3
OnClick 5
OnOpen 4
SendNow 1
Back to top

Channel
SMTP and HTTP API channel for grouping email delivery


PropertiesDescriptionExampleType
ClickedCount The number of emails that have been clicked within this channel.int
Cost The total cost for emails/attachments within this channel.decimal
DateAdded The date the channel was added to your account.datetime
FailedAbuse The number of emails that have been marked as abuse or complaint within this channel.int
FailedCount The number of emails that have been bounced within this channel.int
JobCount The number of email jobs this channel has been used with.int
LastActivity The date the channel was last sent through.datetime?
Name Descriptive name of the channel.string
OpenedCount The number of emails that have been opened within this channel.int
RecipientCount The number of emails attempted to be sent within this channel.int
SentCount The number of emails that have been sent within this channel.int
UnsubscribedCount The number of emails that have been unsubscribed within this channel.int
Back to top

CompressionFormat Enumeration
FileResponse compression format


ValuesValueDescription
None 0No compression
Zip 1Zip compression
Back to top

Contact
Contact


PropertiesDescriptionExampleType
AnnualRevenue Annual revenue of contact75000decimal?
BirthDate Date of birth in YYYY-MM-DD format2001-01-01datetime?
BouncedErrorCode RFC Error code550int?
BouncedErrorMessage RFC error messageMailbox not foundstring
City City.CITYstring
Country Name of country.Canadastring
CreatedFromIP IP address192.168.0.1string
DateAdded Date of creation in YYYY-MM-DDThh:ii:ss format2001-01-01T12:00:00datetime
DateUpdated Last change date2001-01-01:12:00:00datetime
Email Proper email address.mail@example.comstring
ErrorCode RFC Error code550int?
FaxNumber Fax number1234567890string
FirstFailedDate Date of first failed message2001-01-01:12:00:00datetime?
FirstName First name.FIRSTNAMEstring
FirstPurchase Date of first purchase in YYYY-MM-DD format2014-01-01datetime?
FriendlyErrorMessage RFC error messageMailbox not foundstring
Gender Your genderF/Mstring
GravatarHash Your gravatar hash for imageb642b4217b34b1e8d3bd915fc65c4452string
Industry Industry contact works inFinancestring
LastClicked datetime?
LastFailedCount Number of fails in sending to this Contact1int
LastMonthSent Number of messages sent last month10int?
LastName Last name.LASTNAMEstring
LastOpened Date this contact last opened an email2014-01-01datetime?
LastPurchase Date of last purchase in YYYY-MM-DD format2015-01-01datetime?
LinkedInBio Biography for Linked-InShort biography for Link-In Profilestring
LinkedInConnections Number of Linked-In connections50int
MobileNumber Mobile phone number1234567890string
Notes Free form field of notesContact is extremely important!string
NumberOfEmployees Number of employees100int
OrganizationName Name of organizationABC Inc.string
PageViews Number of page views50int
Phone Phone number1234567890string
PurchaseCount Number of purchases contact has made2int
Revenue Yearly revenue for the contact100000decimal
Source Source of URL of paymenthttp://ContactSource
State State or province.STATEstring
Status Name of status: Active, Engaged, Inactive, Abuse, Bounced, Unsubscribed.BouncedContactStatus
Title TitleMrs./Mr.string
TotalClicked Total emails clicked1000int
TotalFailed Total emails sent.1000int
TotalOpened Total emails opened.1000int
TotalSent Total emails sent.1000int
TwitterBio Biography for TwitterShort biography for Twitter Profilestring
TwitterFollowerCount Number of Twitter followers50int
TwitterProfilePhoto URL for Twitter photohttp://string
TwitterUsername User name for Twitter@elastic_emailstring
UnsubscribedDate Unsubscribed date in YYYY-MM-DD format2001-01-01datetime?
Visits Number of website visits100int
WebsiteUrl Website of contacthttp://string
Zip Zip/postal code.ZIP/POSTALstring
Back to top

ContactCollection
Collection of lists and segments


PropertiesDescriptionExampleType
Lists Lists which contain the requested contactList of ContactContainer
Segments Segments which contain the requested contactList of ContactContainer
Back to top

ContactContainer
List's or segment's short info


PropertiesDescriptionExampleType
ID ID of the list/segmentint
Name Name of the list/segmentstring
Back to top

ContactHistory
History of chosen Contact


PropertiesDescriptionExampleType
ChannelName Name of selected channel.Channel01string
ContactHistoryID ID of history of selected Contact.123456long
EventDate Formatted date of event.1/1/2015 0:00:00 AMstring
EventType Type of event occured on this Contact.Sentstring
EventTypeValue Numeric code of event occured on this Contact.1int
TemplateName Name of template.Template01string
Back to top

ContactSource Enumeration


ValuesValueDescription
ContactApi 4Contact was added from the contact api.
DeliveryApi 0Source of the contact is from sending an email via our SMTP or HTTP API's
FileUpload 2Contact was uploaded via a file such as CSV.
ManualInput 1Contact was manually entered from the interface.
WebForm 3Contact was added from a public web form.
Back to top

ContactStatus Enumeration


ValuesValueDescription
Abuse 3Contact has complained and is no longer eligible to be sent to.
Active 0Contact is eligible to be sent to.
Bounced 1Contact has had a hard bounce and is no longer eligible to be sent to.
Engaged -1Contact has had an open or click in the last 6 months.
Inactive 4Contact has not been activated or has been de-activated and is not eligible to be sent to.
Transactional -2Only transactional email can be sent to contacts with this status.
Unsubscribed 2Contact has unsubscribed and is no longer eligible to be sent to.
Back to top

ContactStatusCounts
Number of Contacts, grouped by Status;


PropertiesDescriptionExampleType
Active Number of active contacts1000long
Bounced Number of bounced messages1000long
Complaint Number of complaint messages1000long
Engaged Number of engaged contacts1000long
Inactive Number of inactive contacts1000long
Transactional long
Unsubscribed Number of unsubscribed messages1000long
Back to top

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


PropertiesDescriptionExampleType
Bounced Number of bounced messages1000int
Clicked Number of clicked messages1000int
Complaint Number of complaint messages1000int
Date Date in YYYY-MM-DDThh:ii:ss format2001-01-01T12:00:00string
Delivered Number of delivered messages1000int
Email Proper email address.mail@example.comint
Inbound Number of inbound messages1000int
ManualCancel Number of manually cancelled messages1000int
NotDelivered Number of messages flagged with 'Not Delivered'0int
Opened Number of opened messages1000int
Sms Number of SMS12int
Unsubscribed Number of unsubscribed messages1000int
Back to top

DomainDetail
Domain data, with information about domain records.


PropertiesDescriptionExampleType
DefaultDomain True, if domain is used as default. Otherwise, false,boolean
Dkim True, if DKIM record is verifiedTrueboolean
DMARC boolean
Domain Name of selected domain.example.comstring
IsRewriteDomainValid True, if tracking CNAME record is verifiedTrueboolean
MX True, if MX record is verifiedTrueboolean
Spf True, if SPF record is verifiedTrueboolean
Verify True, if verification is availableTrueboolean
Back to top

EmailCredits
Detailed information about email credits


PropertiesDescriptionExampleType
Amount Amount of money in transaction100decimal
Date Date in YYYY-MM-DDThh:ii:ss format2001-01-01T12:00:00datetime
Notes Free form field of notesContact is extremely important!string
Source Source of URL of paymenthttp://string
Back to top

EmailJobFailedStatus


PropertiesDescriptionExampleType
Address string
Category string
Error string
ErrorCode RFC Error code550int
Back to top

EmailJobStatus


PropertiesDescriptionExampleType
AbuseReports List of string
AbuseReportsCount int
Clicked Number of clicked messages1000List of string
ClickedCount Total emails clicked1000int
Delivered Number of delivered messages1000List of string
DeliveredCount int
Failed List of EmailJobFailedStatus
FailedCount Total emails sent.1000int
ID ID number of your attachment123456string
MessageIDs List of all MessageIDs for this job.List of string
Opened Number of opened messages1000List of string
OpenedCount Total emails opened.1000int
Pending List of string
PendingCount int
RecipientsCount int
Status Name of status: submitted, complete, in_progressstring
Unsubscribed Number of unsubscribed messages1000List of string
UnsubscribedCount Total emails clicked1000int
Back to top

EmailSend


PropertiesDescriptionExampleType
MessageID Unique identifier for this email.-HHGPM_9RPhSMiaJq_ab4g3string
TransactionID ID number of transactionTransactionIDstring
Back to top

EmailStatus
Status information of the specified email


PropertiesDescriptionExampleType
Date Date the email was submitted.datetime
ErrorMessage Detailed error or bounced message.string
From Email address this email was sent from.string
Status Value of email's statusLogJobStatus
StatusChangeDate Date of last status change.2001-01-01:12:00:00datetime
StatusName Name of email's statusstring
To Email address this email was sent to.string
TransactionID ID number of transactionTransactionIDGUID
Back to top

EmailView
Email details formatted in json


PropertiesDescriptionExampleType
Body Body (text) of your message.Hellostring
From Starting date for search in YYYY-MM-DDThh:mm:ss format.2001-01-01T01:01:01string
Subject Default subject of email.Hello!string
Back to top

EncodingType Enumeration
Encoding type for the email headers


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

Export
Record of exported data from the system.


PropertiesDescriptionExampleType
DateAdded Date the export was createddatetime
Filename Name of the filestring
Info Long description of the exportstring
Link Link to download the exportstring
PublicExportID GUID
Status Current status of exportstring
Type Type of exportstring
Back to top

ExportFileFormats Enumeration
Type of export


ValuesValueDescription
Csv 1Export in comma separated values format.
Json 3Export in json format
Xml 2Export in xml format
Back to top

PropertiesDescriptionExampleType
Link Direct URL to the exported filestring
Back to top

ExportStatus Enumeration
Current status of export


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

ExportTypeCounts
Number of Exports, grouped by export type


PropertiesDescriptionExampleType
Campaign Json representation of a campaignlong
Contact long
LinkTracking True, if you have enabled link tracking. Otherwise, falsetruelong
Log long
Survey Json representation of a surveylong
Back to top

LinkTrackingDetails
Object containig tracking data.


PropertiesDescriptionExampleType
Count Number of items.100int
MoreAvailable True, if there are more detailed data available. Otherwise, falsetrueboolean
TrackedLink List of TrackedLink
Back to top

List
List of Contacts, with detailed data about its contents.


PropertiesDescriptionExampleType
AllowUnsubscribe True: Allow unsubscribing from this list. Otherwise, falsetrue/falseboolean
Count Number of items.100int
DateAdded Date of creation in YYYY-MM-DDThh:ii:ss format2001-01-01T12:00:00datetime
ListID ID number of selected list.1234int
ListName Name of your list.My List 1string
PublicListID ID code of listpublic-id-of-your-listGUID?
Rule Query used for filtering.Status%20=%20Engagedstring
Back to top

LitmusCredits
Detailed information about litmus credits


PropertiesDescriptionExampleType
Amount Amount of money in transaction100decimal
Date Date in YYYY-MM-DDThh:ii:ss format2001-01-01T12:00:00datetime
Back to top

Log
Logs for selected date range


PropertiesDescriptionExampleType
From Starting date for search in YYYY-MM-DDThh:mm:ss format.2001-01-01T01:01:01datetime?
Recipients Number of recipients1234List of Recipient
To Ending date for search in YYYY-MM-DDThh:mm:ss format.2001-01-01T01:01:01datetime?
Back to top

LogJobStatus Enumeration


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

LogStatusSummary
Summary of log status, based on specified date range.


PropertiesDescriptionExampleType
Bounced Number of bounced messages1000long
Clicked Number of clicked messages1000long
Complaints Number of complaint messages1000long
Delivered Number of delivered messages1000long
Duration Overall durationdouble
EmailTotal Number of emails1234long
From Starting date for search in YYYY-MM-DDThh:mm:ss format.2001-01-01T01:01:01string
Inbound Number of inbound messages1000long
InProgress Number of messages in progress1234long
ManualCancel Number of manually cancelled messages1000long
NotDelivered Number of messages flagged with 'Not Delivered'0long
Opened Number of opened messages1000long
Recipients Number of recipients1234long
SmsTotal Number of SMS12long
TemplateChannel ID number of template used1234boolean
To Ending date for search in YYYY-MM-DDThh:mm:ss format.2001-01-01T01:01:01string
Unsubscribed Number of unsubscribed messages1000long
Back to top

LogSummary
Overall log summary information.


PropertiesDescriptionExampleType
BouncedCategorySummary Summary of bounced categories, based on specified date range.BouncedCategorySummary
DailyLogStatusSummary Daily summary of log status, based on specified date range.List of DailyLogStatusSummary
LogStatusSummary Summary of log status, based on specified date range.LogStatusSummary
Back to top

MessageCategory Enumeration


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

NotificationQueue
Queue of notifications


PropertiesDescriptionExampleType
DateCreated Creation date.2001-01-01:12:00:00string
ErrorMessage Error message.Bouncedstring
NewStatus Actual status.Activestring
Reference string
RetryCount Number of previous delivery attempts2string
StatusChangeDate Date of last status change.2001-01-01:12:00:00string
Back to top

Payment
Detailed information about existing money transfers.


PropertiesDescriptionExampleType
Amount Amount of money in transaction100decimal
Date Date in YYYY-MM-DDThh:ii:ss format2001-01-01T12:00:00datetime
Source Source of URL of paymenthttp://string
Back to top

PrivateIP
Private IP Address


PropertiesDescriptionExampleType
IPAddress Assigned Private IP address.string
MXToolBox Link to MX ToolBox blacklist check for this IP address.string
rDNSConfiguration Configuration information to set up a custom rDNS A record.string
SenderScore Link to Sender Score for this IP address to view external reputation.string
Back to top

Profile
Basic information about your profile


PropertiesDescriptionExampleType
Address1 First line of address.ADDRESS1string
Address2 Second line of address.ADDRESS2string
City City.CITYstring
Company Company name.COMPANYstring
CountryID Numeric ID of country. A file with the list of countries is available here12345int?
Email Proper email address.mail@example.comstring
FirstName First name.FIRSTNAMEstring
LastName Last name.LASTNAMEstring
Phone Phone number1234567890string
State State or province.STATEstring
TaxCode Code used for tax purposes.string
Zip Zip/postal code.ZIP/POSTALstring
Back to top

QuestionType Enumeration


ValuesValueDescription
Checkboxes 3
Date 6Date in YYYY-MM-DDThh:ii:ss format
DropdownMenu 2
LongAnswer 4
RadioButtons 1
Textbox 5
Back to top

Recipient
Detailed information about message recipient


PropertiesDescriptionExampleType
Channel Name of selected Channel.Channel01string
Date Date in YYYY-MM-DDThh:ii:ss format2001-01-01T12:00:00string
FromEmail Default From: email address.sender@yourdomain.comstring
IsSms True, if message is SMS. Otherwise, falseTrueboolean
JobID ID of certain mail jobstring
Message Content of message, HTML encodedLorem ipsumstring
MessageCategory Name of message categorystring
MessageCategoryID ID of message categoryMessageCategory
MessageSid Comma separated ID numbers of messages.12345678,1234567890string
MsgID ID number of selected message.MessageIDstring
NextTryOn Date of next try2001-01-01T12:00:00string
ShowCategory True, if message category should be shown. Otherwise, falsetrueboolean
SmsUpdateRequired True, if message is a SMS and status is not yet confirmed. Otherwise, falsefalseboolean
Status Name of recipient's status: Submitted, ReadyToSend, WaitingToRetry, Sending, Bounced, Sent, Opened, Clicked, Unsubscribed, AbuseReportstring
StatusChangeDate Date of last status change.2001-01-01:12:00:00string
Subject Default subject of email.Hello!string
TextMessage Content of messageLorem ipsumstring
To Ending date for search in YYYY-MM-DDThh:mm:ss format.2001-01-01T01:01:01string
Back to top

Referral
Referral details for this account.


PropertiesDescriptionExampleType
CurrentReferralCount Number of active referrals.5long
CurrentReferralCredit Current amount of dolars you have from referring.10decimal
Back to top

ReputationDetail
Detailed sending reputation of your account.


PropertiesDescriptionExampleType
AbusePercent Percent of Complaining users - those, who do not want to receive email from you.0.00double
AverageReputation Average reputation.50double
AverageSpamScore Penalty from messages marked as spam.0double
FailedSpamPercent Percent of Bounced users0.00double
Impact Overall reputation impact, based on the most important factors.ReputationImpact
NextPriceLevelReputation Reputation needed to change pricing.70double
PriceLevel Amount of emails sent from this account1000string
PriceLevelReputation Actual price level.50double
RepEmailsSent Points from quantity of your emails.0double
SenderDomainValid True, if sending domain is correctly configured. Otherwise, false.trueboolean
TrackingDomainValid True, if tracking domain is correctly configured. Otherwise, false.trueboolean
UnknownUsersPercent Percent of Unknown users - users that couldn't be found0.00double
Back to top

ReputationHistory
Reputation history of your account.


PropertiesDescriptionExampleType
AbusePercent Percent of Complaining users - those, who do not want to receive email from you.0.00double
AverageSpamScore Penalty from messages marked as spam.0double
DateCreated Creation date.2001-01-01:12:00:00string
RepEmailsSent Points from quantity of your emails.0double
Reputation Numeric reputation100double
SetupScore Points from proper setup of your account0double
UnknownUsersPercent Percent of Unknown users - users that couldn't be found0.00double
Back to top

ReputationImpact
Overall reputation impact, based on the most important factors.


PropertiesDescriptionExampleType
Abuse Abuses - mails sent to user without their consent0.00double
AverageSpamScore Penalty from messages marked as spam.0double
SenderDomain Sending domain.example.comdouble
ServerFilter Content analysis.0.00double
TotalEmailSent Total emails sent.1000double
TrackingDomain Tracking domain.example.comdouble
UnknownUsers Users, that could not be reached.0.00double
Back to top

Segment
Information about Contact Segment, selected by RULE.


PropertiesDescriptionExampleType
History History of segment information.List of SegmentHistory
LastCount Number of items from last check.100long
Name Filenameattachment.txtstring
Rule Query used for filtering.Status%20=%20Engagedstring
SegmentID ID number of your segment.1234int
Back to top

SegmentHistory
Segment History


PropertiesDescriptionExampleType
AbuseCount long
ActiveCount long
BouncedCount long
Count Number of items.100long
Day Date in YYYY-MM-DD format2001-01-01int
EngagedCount long
InactiveCount long
SegmentHistoryID ID number of history.1234567int
SegmentID ID number of your segment.1234int
UnsubscribedCount Total emails clicked1000long
Back to top

SendingPermission Enumeration


ValuesValueDescription
All 255Sending allowed via SMTP, HTTP API and the website interface.
HttpApi 2Allow sending via HTTP API only.
HttpApiAndInterface 6Allow sendnig via HTTP API and the website interface.
Interface 4Allow sending via the website interface only.
None 0Sending not allowed.
Smtp 1Allow sending via SMTP only.
SmtpAndHttpApi 3Allow sending via SMTP and HTTP API.
SmtpAndInterface 5Allow sending via SMTP and the website interface.
Back to top

SpamCheck
Spam check of specified message.


PropertiesDescriptionExampleType
ChannelName Name of selected channel.Channel01string
Date Date in YYYY-MM-DDThh:ii:ss format2001-01-01T12:00:00string
FromEmail Default From: email address.sender@yourdomain.comstring
MsgID ID number of selected message.MessageIDstring
Rules List of SpamRule
Subject Default subject of email.Hello!string
TotalScore Total spam score from5.5string
Back to top

SpamRule
Single spam score


PropertiesDescriptionExampleType
Description Description of rule.Very long subject, possibly filled up with randomstring
Key Name of ruleJAM_LONG_SUBJECTstring
Score Spam score2.5string
Back to top

SplitOptimization Enumeration


ValuesValueDescription
Clicked 1Number of clicked messages
Opened 0Number of opened messages
Back to top

SubAccount
Subaccount. Contains detailed data of your Subaccount.


PropertiesDescriptionExampleType
AbusePercent Percent of Complaining users - those, who do not want to receive email from you.0.00double
AccountType Type of account: 1 for Transactional Email, 2 for Marketing Email.2AccountType
ApiKey ApiKey that gives you access to our SMTP and HTTP API's.94DAF66E-4DF6-4E8E-AF96-D094A8D21DF3string
DailySendLimit Amount of emails account can send daily100000long
Email Proper email address.mail@example.comstring
EmailCredits Amount of email credits1000string
EnableLitmusTest True, if account is able to send template tests to Litmus. Otherwise, falseFalseboolean
EnablePremiumTemplates True, if account can buy templates on its own. Otherwise, falseTrueboolean
EnablePrivateIPRequest True, if account can request for private IP on its own. Otherwise, falseTrueboolean
FailedSpamPercent Percent of Bounced users0.00double
LastActivity Date of last activity on account2001-01-01T12:00:00string
LitmusCredits Amount of Litmus credits1000decimal
MailerID ID number of mailer-9string
MonthlyRefillCredits Amount of credits added to account automatically1000double
PoolName Name of your custom IP Pool to be used in the sending processMy Custom Poolstring
PublicAccountID Public key for limited access to your account such as contact/add so you can use it safely on public websites.EB3EBB7A-C20D-4D39-8F2F-5E6842F58E6Fstring
Reputation Numeric reputation100double
RequiresEmailCredits True, if account needs credits to send emails. Otherwise, falseTrueboolean
RequiresLitmusCredits True, if account needs credits to send emails. Otherwise, falseTrueboolean
RequiresTemplateCredits True, if account needs credits to buy templates. Otherwise, falseTrueboolean
Status Name of account's status: Deleted, Disabled, UnderReview, NoPaymentsAllowed, NeverSignedIn, Active, SystemPausedstring
TotalEmailsSent Amount of emails sent from this account1000long
UnknownUsersPercent Percent of Unknown users - users that couldn't be found0.00double
Back to top

SubAccountSettings
Detailed account settings.


PropertiesDescriptionExampleType
DailySendLimit Amount of emails account can send daily100000int
Email Proper email address.mail@example.comstring
EmailSizeLimit Maximum size of email including attachments in MB's10int
EnableContactFeatures True, if you want to use Advanced Tools. Otherwise, falseboolean
EnableLitmusTest True, if account is able to send template tests to Litmus. Otherwise, falseFalseboolean
EnablePrivateIPRequest True, if account can request for private IP on its own. Otherwise, falseTrueboolean
LitmusCredits Amount of Litmus credits1000decimal
MaxContacts Maximum number of contacts the account can havelkd100000int
MonthlyRefillCredits Amount of credits added to account automatically1000double
PoolName Name of your custom IP Pool to be used in the sending processMy Custom Poolstring
PublicAccountID Public key for limited access to your account such as contact/add so you can use it safely on public websites.EB3EBB7A-C20D-4D39-8F2F-5E6842F58E6Fstring
RequiresEmailCredits True, if account needs credits to send emails. Otherwise, falseTrueboolean
RequiresLitmusCredits True, if account needs credits to send emails. Otherwise, falseTrueboolean
RequiresTemplateCredits True, if account needs credits to buy templates. Otherwise, falseTrueboolean
SendingPermission Sending permission setting for accountAllSendingPermission
Back to top

Survey
A survey object


PropertiesDescriptionExampleType
DateCreated Creation date.2001-01-01:12:00:00datetime
DateUpdated Last change date2001-01-01:12:00:00datetime?
Name Filenameattachment.txtstring
PublicSurveyID Survey identifier123456GUID
ResultCount Number of results count1000int
Status Activate, delete, or pause your surveySurveyStatus
SurveyLink URL of the surveystring
SurveyStep Survey's steps infoList of SurveyStep
Back to top

SurveyResultAnswerInfo
Object with the single answer's data


PropertiesDescriptionExampleType
content Answer's contentstring
surveystepanswerid Identifier of the answer of the step123456string
surveystepid Identifier of the step123456int
Back to top

SurveyResultInfo
Single answer's data with user's specific info


PropertiesDescriptionExampleType
CreatedFromIP IP address192.168.0.1string
DateCompleted Completion date2001-01-01T01:01:01datetime
DateStart Start date2001-01-01T01:01:01datetime
SurveyResultAnswers Answers for the surveyList of SurveyResultAnswerInfo
SurveyResultID Identifier of the result123456string
Back to top

SurveyResultsSummary
Summary with all the answers


PropertiesDescriptionExampleType
Answers Answers' statisticsRepeated list of string keys and int values
OpenAnswers Open answers for the questionList of string
Back to top

SurveyResultsSummaryInfo
Data on the survey's result


PropertiesDescriptionExampleType
Count Number of items.100int
Summary Summary statisticsRepeated list of int keys and SurveyResultsSummary values
Back to top

SurveyStatus Enumeration


ValuesValueDescription
Active 1The survey is active and receiving answers
Deleted -1The survey is deleted
Paused 0The survey is not receiving result for now
Back to top

SurveyStep
Survey's single step info with the answers


PropertiesDescriptionExampleType
Content Answer's contentstring
QuestionType Type of the questionCheckboxesQuestionType
Required Is the answer requiredTrueboolean
Sequence Sequence of the answers15342int
SurveyStepAnswer Answer object of the stepList of SurveyStepAnswer
SurveyStepID Identifier of the step123456int
SurveyStepType Type of the stepTextMediaSurveyStepType
Back to top

SurveyStepAnswer
Single step's answer object


PropertiesDescriptionExampleType
Content Answer's contentstring
Sequence Sequence of the answers15342int
SurveyStepAnswerID Identifier of the answer of the step123456string
Back to top

SurveyStepType Enumeration


ValuesValueDescription
ConfirmationPage 4
ExpiredPage 5
PageBreak 1
Question 2
TextMedia 3
Back to top

Template
Template


PropertiesDescriptionExampleType
BodyHtml HTML code of email (needs escaping).<BODY><H1>Hello!</H1></BODY>string
BodyText Text body of email.Hello%20Worldstring
Css CSS stylebody:{color:black;}string
DateAdded Date of creation in YYYY-MM-DDThh:ii:ss format2001-01-01T12:00:00datetime
FromEmail Default From: email address.sender@yourdomain.comstring
FromName Default From: name.Senderstring
Name Filenameattachment.txtstring
OriginalTemplateID ID number of original template.123int
Subject Default subject of email.Hello!string
TemplateID ID number of template.1234int
TemplateScope Enum: 0 - private, 1 - public, 2 - mockup1TemplateScope
TemplateType 0 for API connections0TemplateType
Back to top

TemplateList
List of templates


PropertiesDescriptionExampleType
Back to top

TemplateScope Enumeration


ValuesValueDescription
Private 0Template is available for this account only.
Public 1Template is available for this account and it's sub-accounts.
Back to top

TemplateType Enumeration


ValuesValueDescription
DragDropEditor 1Template is created and can only be modified in drag and drop editor
RawHTML 0Template supports any valid HTML
Back to top

PropertiesDescriptionExampleType
Clicks Number of clicks10string
Link URL clickedhttp://string
Percent Percent of clicks10%string
Back to top

Usage
Account usage


PropertiesDescriptionExampleType
Back to top