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.

Popular:

GETPOST HTTP method the platform expects  ·  read returns data  ·  write changes something  ·  destructive deletes, sends or unsubscribes — hard to take back.

home · Home

The people on your account.

4 calls

clients · Clients

For agencies and resellers running many accounts.

1 call

email · Email Marketing

The bulk of the API. Lists, messages, campaigns, domains and IPs, single sends and reporting.

87 calls

Lists

addemail

POSTwrite

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

createlist

POSTwrite

Allows creating a list by passing a data containing email addresses

deleteemailbyemail

POSTdestructive

Deletes an email address from a list given it's list id and email address

deleteemailbyemailid

POSTdestructive

Deletes an email address from a list given it's list id and email id

deletelist

POSTdestructive

Deletes a list by a list id

editemail

POSTwrite

Edits an email entry inside a list. Given either email address or email id.

getdatafeeds

GETread

Gets a list of data feeds from the account

getfeedbackloopconfirmationemails

GETread

Gets a list of feedback confirmation emails from the account.

getlistdetail

GETread

Gets a list of emails from the list with all the columns.

getlistfields

GETread

Returns a list of fields inside a list. Which can be used submitted when using the addemail function call

getlisthardbounces

GETread

Gets a list of hard bounces from a list given the listid.

getlists

GETread

Returns a list of email lists found in the account

getunsubscribelist

GETread

This api returns a list of optouts from the unsubscribe list of the account.

mergelist

POSTwrite

Merges multiple lists together into a new list. Keeps the original list!

unsubscribedomain

POSTdestructive

This api allows you to unsubscribe a domain by adding it to the account's unsubscribe list.

unsubscribeemail

POSTwrite

This api allows you to unsubscribe an email address by adding it to the account's unsubscribe list.

uploadlistbyurl

POSTwrite

Uploads a list to the account given a url to a list.

uploadlistfile

POSTwrite

Allows you to upload a list to the system either csv,txt file or a zip file containing txt or csv files.

Campaigns

blreport

POSTwrite

Gets list of blocked responses from a campaign that appear to be from blacklists

campaignlog

GETread

Gets the details of a campaign from the campaign log. For each chunk update. This data builds the campaign graph.

createcampaign

POSTdestructive

Sends an email campaign

deletecampaign

POSTdestructive

Deletes a campaign given a campaign id

deletereoccurringcampaign

POSTdestructive

Deletes a recurring campaign given the recurring id

deletetrigger

POSTdestructive

Deletes a trigger given a trigger id

editcampaign

POSTwrite

Allows editing of a campaign

getallclicks

GETread

Gets all the clicks from all campaigns. Returns the email, date/time, and ip address, and campaign id.

getallopens

GETread

Gets all the opens from all campaigns. Returns the email, date/time, and ip address, and campaign id.

getcampaigndetail

GETread

Get a detailed high level information from a campaign

getcampaignresults

GETread

Shows each individual email delivery result from a campaign.

getcampaigns

GETread

Returns a list of campaigns from the account.

getcampaigntriggers

GETread

Get list of campaigns triggers in the account

getclicklog

GETread

Returns a list of emalis,ip,date,revenue from click logs for the specified campaign.

getconversionlog

GETread

Returns a list of emalis,ip,date,revenue from conversion logs for the specified campaign.

getopenlog

GETread

Returns a list of emalis,ip,date,revenue from open logs for the specified campaign.

getrecurringcampaigns

GETread

Gets a list of recurring campaigns in the account.

pausecampaign

POSTwrite

Pauses a campaign given a campaign id

resumecampaign

POSTwrite

Resumes a campaign given a campaign id

retryerrorcampaign

POSTwrite

Retries an errored campaign given a campaign id

Domains and IPs

addcustomdomain

POSTwrite

Adds a custom domain to be used to send on behalf.

addcustomfromaddress

POSTwrite

Adds a custom from address given a custom domain id

adddomain

POSTwrite

Adds a domain to a users account. Charges $17 for a .com domain unless it is a user controlled domain

addprofile

POSTwrite

Adds a sending profile to the account given an IP ID and Domain ID.

deletecustomdomain

POSTdestructive

Deletes a custom domain used for sending on behalf. Also deletes any custom from addresses that have been setup using that domain

deletecustomfromaddress

POSTdestructive

Deletes a custom from address given the id.

deletedomain

POSTdestructive

This deletes a domain from the account.

deleteprofile

POSTdestructive

Deletes a sending profile given its id from the account

getcustomdomains

GETread

Gets list of custom verified domains to send on behalf of

getdomainblacklisthistory

GETread

Gets the domain blacklist history from the account if monitoring is enabled.

getdomains

GETread

Returns a list of domains from the account

getipblacklisthistory

GETread

Gets the ip blacklist history of ips. Entries are created by the monitoring system.

getips

GETread

Returns a list of ips inside the account.

getsenderscorehistory

GETread

Gets sender score history for ips

getsendingprofiles

GETread

Returns a list of sending profiles from the account.

getservers

GETread

Gets a list of servers from inside the account

updatedomainsettings

POSTwrite

Updates the domains forwarding email and redirection url settings

verifycustomdomain

POSTwrite

Runs the verification check again for the custom domain to see if the DNS records are added.

viewzonefile

View zone file of a domain given the domain id

support · Support

Reading and raising support tickets.

2 calls

listverify · List verification

Running and monitoring list verification jobs.

11 calls

api · API

Managing your own webhook subscriptions.

3 calls

Need a call that isn't here?

Custom integration work is quoted on scope, and support is a person on weekdays, 9am to 5pm CST.