Every call, by area.
108 calls across six areas. Each one has its own page with arguments, an example URL and a sample response. Pass area and action exactly as shown.
108 calls across six areas. Each one has its own page with arguments, an example URL and a sample response. Pass area and action exactly as shown.
GETPOST HTTP method the platform expects · read returns data · write changes something · destructive deletes, sends or unsubscribes — hard to take back.
home · HomeThe people on your account.
clients · ClientsFor agencies and resellers running many accounts.
email · Email MarketingThe bulk of the API. Lists, messages, campaigns, domains and IPs, single sends and reporting.
addemailAdds an email to a list, when giving the list id. Also supports custom columns if they already exist in the list just pass the column name via the request.
createlistAllows creating a list by passing a data containing email addresses
deleteemailbyemailDeletes an email address from a list given it's list id and email address
deleteemailbyemailidDeletes an email address from a list given it's list id and email id
deletelistDeletes a list by a list id
editemailEdits an email entry inside a list. Given either email address or email id.
getdatafeedsGets a list of data feeds from the account
getfeedbackloopconfirmationemailsGets a list of feedback confirmation emails from the account.
getlistdetailGets a list of emails from the list with all the columns.
getlistfieldsReturns a list of fields inside a list. Which can be used submitted when using the addemail function call
getlisthardbouncesGets a list of hard bounces from a list given the listid.
getlistsReturns a list of email lists found in the account
getunsubscribelistThis api returns a list of optouts from the unsubscribe list of the account.
mergelistMerges multiple lists together into a new list. Keeps the original list!
unsubscribedomainThis api allows you to unsubscribe a domain by adding it to the account's unsubscribe list.
unsubscribeemailThis api allows you to unsubscribe an email address by adding it to the account's unsubscribe list.
uploadlistbyurlUploads a list to the account given a url to a list.
uploadlistfileAllows you to upload a list to the system either csv,txt file or a zip file containing txt or csv files.
addmessageThis api allows you to remotely add a message to your email marketing account.
checkspamassassinReturns the results of the spam assassin content check
deleteimageDeletes an image given an image id
deletemessageDelete a message by message id
editmessageAllows editing of a message in the system.
getmessagedetailThis api returns the html and text content of message given the id of the message.
getmessagesReturns a list of messages in the account
blreportGets list of blocked responses from a campaign that appear to be from blacklists
campaignlogGets the details of a campaign from the campaign log. For each chunk update. This data builds the campaign graph.
createcampaignSends an email campaign
deletecampaignDeletes a campaign given a campaign id
deletereoccurringcampaignDeletes a recurring campaign given the recurring id
deletetriggerDeletes a trigger given a trigger id
editcampaignAllows editing of a campaign
getallclicksGets all the clicks from all campaigns. Returns the email, date/time, and ip address, and campaign id.
getallopensGets all the opens from all campaigns. Returns the email, date/time, and ip address, and campaign id.
getcampaigndetailGet a detailed high level information from a campaign
getcampaignresultsShows each individual email delivery result from a campaign.
getcampaignsReturns a list of campaigns from the account.
getcampaigntriggersGet list of campaigns triggers in the account
getclicklogReturns a list of emalis,ip,date,revenue from click logs for the specified campaign.
getconversionlogReturns a list of emalis,ip,date,revenue from conversion logs for the specified campaign.
getopenlogReturns a list of emalis,ip,date,revenue from open logs for the specified campaign.
getrecurringcampaignsGets a list of recurring campaigns in the account.
pausecampaignPauses a campaign given a campaign id
resumecampaignResumes a campaign given a campaign id
retryerrorcampaignRetries an errored campaign given a campaign id
addcustomdomainAdds a custom domain to be used to send on behalf.
addcustomfromaddressAdds a custom from address given a custom domain id
adddomainAdds a domain to a users account. Charges $17 for a .com domain unless it is a user controlled domain
addprofileAdds a sending profile to the account given an IP ID and Domain ID.
deletecustomdomainDeletes a custom domain used for sending on behalf. Also deletes any custom from addresses that have been setup using that domain
deletecustomfromaddressDeletes a custom from address given the id.
deletedomainThis deletes a domain from the account.
deleteprofileDeletes a sending profile given its id from the account
getcustomdomainsGets list of custom verified domains to send on behalf of
getdomainblacklisthistoryGets the domain blacklist history from the account if monitoring is enabled.
getdomainsReturns a list of domains from the account
getipblacklisthistoryGets the ip blacklist history of ips. Entries are created by the monitoring system.
getipsReturns a list of ips inside the account.
getsenderscorehistoryGets sender score history for ips
getsendingprofilesReturns a list of sending profiles from the account.
getserversGets a list of servers from inside the account
updatedomainsettingsUpdates the domains forwarding email and redirection url settings
verifycustomdomainRuns the verification check again for the custom domain to see if the DNS records are added.
viewzonefileView zone file of a domain given the domain id
addsmtpserverAdds a SMTP Server for use in remote SMTP Campaigns
deletesmtpserverDelete SMTP Server given the id of the server
editsmtpserverEdit's a SMTP Server given the server id.
getclicklogsmtpGets the SMTP click log from a single email send API/quick send or the SMTP API
getopenlogsmtpGets the SMTP open log from a single email send API/quick send or the SMTP API
getresultsendsingleemailGets the result of the sendsingleemail api call or SMTP API
getsmtpandapiresultsGets a list of all SMTP and API email sends.
getsmtpbounceserversGet a list of bounce servers.
getsmtpcredentialsGet the list of SMTP Credentials to allow you to use the SMTP API
getsmtpserversGets a list of SMTP servers from the account.
sendsingleemailAllows to send a single email to a recipient
addcanspamwhoisinfoAdds a can spam/whois information to the account returns whoisid
addfolderAdd a folder to group lists, messages or images.
deletewhoisDeletes a whois/CAN SPAM footer entry given a whois id
editcanspamwhoisinfoEdits a can spam/whois information in the account
getaccountinfoReturns basic account information. Such as billing period, number of emails sent, package size, total ips, total domains.
getcanspamwhoisinfoGets a list of whois/can spam footer addresses from the account
getfeedbackloopreportsGets a list of feedback reports
getimagesGets a list of images from imagehosting inside the account.
getrepliesGets a list of email replies
getreplyemlReturns an EML file which can be opened in outlook given a reply id
uploadimageAllows uploading of an image file to be imported into image hosting
viewreplyViews a specific reply email message.
support · SupportReading and raising support tickets.
listverify · List verificationRunning and monitoring list verification jobs.
deletelistDeletes a list given the list id
getaccountinfoGets list verify package information and total stats for all lists in the account.
getlistsGets a list of all list verify jobs
getliststatusGet list details
pauseverifyPause a list verify job
resumeverifyResumes a list verify job that was paused
uploadlistbyfileAllows you to upload a list to the system either csv,txt file or a zip file containing txt or csv files.
uploadlistbyurlUploads a list to the account given a url to a list.
verifylistVerify an unverified list given the list id from the list verify section
verifysingleemailAllows you to verify an email address real time.
viewlistGets all the list records from a verified list.
api · APIManaging your own webhook subscriptions.
Nothing matches that search. Try the action name, the area, or a word from what it does.
Custom integration work is quoted on scope, and support is a person on weekdays, 9am to 5pm CST.