Start an export, or get information on export jobs in progress.
View export info
Returns information about an export job. If the export job's state is 'complete', the returned data will include a URL you can use to fetch the results. Every export job produces a zip archive, but the format of the archive is distinct for each job type. The api calls that initiate exports include more details about the output format for that job type.
Returns a list of your exports.
Begins an export of your rejection blacklist. The blacklist will be exported to a zip archive containing a single file named rejects.csv that includes the following fields: email, reason, detail, createdat, expiresat, lasteventat, expires_at.
Begins an export of your rejection whitelist. The whitelist will be exported to a zip archive containing a single file named whitelist.csv that includes the following fields: email, detail, created_at.
Export activity history
Begins an export of your activity history. The activity will be exported to a zip archive containing a single file named activity.csv in the same format as you would be able to export from your account's activity view. It includes the following fields: Date, Email Address, Sender, Subject, Status, Tags, Opens, Clicks, Bounce Detail. If you have configured any custom metadata fields, they will be included in the exported data.
Request and manage Dedicated IPs for your account, and set up reverse DNS.
List ip addresses
Lists your dedicated IPs.
Get ip info
Retrieves information about a single dedicated IP.
Request additional ip
Requests an additional dedicated IP for your account. Accounts may have one outstanding request at any time, and provisioning requests are processed within 24 hours.
Start ip warmup
Begins the warmup process for a dedicated IP. During the warmup process, the Transactional API will gradually increase the percentage of your mail that is sent over the warming-up IP, over a period of roughly 30 days. The rest of your mail will be sent over shared IPs or other dedicated IPs in the same pool.
Cancel ip warmup
Cancels the warmup process for a dedicated IP.
Move ip to different pool
Moves a dedicated IP to a different pool.
Delete ip address
Deletes a dedicated IP. This is permanent and cannot be undone.
List ip pools
Lists your dedicated IP pools.
Get ip pool info
Describes a single dedicated IP pool.
Add ip pool
Creates a pool and returns it. If a pool already exists with this name, no action will be performed.
Delete ip pool
Deletes a pool. A pool must be empty before you can delete it, and you cannot delete your default pool.
Test custom dns
Tests whether a domain name is valid for use as the custom reverse DNS for a dedicated IP.
Set custom dns
Configures the custom DNS name for a dedicated IP.
Manage your inbound domains and routes.
List inbound domains
List the domains that have been configured for inbound delivery.
Add inbound domain
Add an inbound domain to your account.
Check domain settings
Check the MX settings for an inbound domain. The domain must have already been added with the add-domain call.
Delete inbound domain
Delete an inbound domain from the account. All mail will stop routing for this domain immediately.
List mailbox routes
List the mailbox routes defined for an inbound domain.
Add mailbox route
Add a new mailbox route to an inbound domain.
Update mailbox route
Update the pattern or webhook of an existing inbound mailbox route. If null is provided for any fields, the values will remain unchanged.
Delete mailbox route
Delete an existing inbound mailbox route.
Send mime document
Take a raw MIME document destined for a domain with inbound domains set up, and send it to the inbound hook exactly as if it had been sent over SMTP.
Send, schedule, or get information on your emails.
Send new message
Send a new transactional message through the Transactional API.
Send using message template
Send a new transactional message through the Transactional API using a template.
Search messages by date
Search recently sent messages and optionally narrow by date range, tags, senders, and API keys. If no date range is specified, results within the last 7 days are returned. This method may be called up to 20 times per minute. If you need the data more often, you can use /messages/info.json to get the information for a single message, or webhooks to push activity to your own application for querying.
Search messages by hour
Search the content of recently sent messages and return the aggregated hourly stats for matching messages.
Get message info
Get the information for a single recently sent message.
Get message content
Get the full content of a recently sent message.
Parse mime document
Parse the full MIME document for an email message, returning the content of the message broken into its constituent pieces.
Send mime document
Take a raw MIME document for a message, and send it exactly as if it were sent through the Transactional API's SMTP servers.
List scheduled emails
Queries your scheduled emails.
Cancel scheduled email
Cancels a scheduled email.
Reschedules a scheduled email.
Manage your custom metadata fields in your account.
List metadata fields
Get the list of custom metadata fields indexed for the account.
Add metadata field
Add a new custom metadata field to be indexed for the account.
Update metadata field
Update an existing custom metadata field.
Delete metadata field
Delete an existing custom metadata field. Deletion isn't instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete.
Add, list, or delete from your Rejection Blocklist.
Add email to blacklist
Adds an email to your email rejection blacklist. Addresses that you add manually will never expire and there is no reputation penalty for removing them from your blacklist. Attempting to blacklist an address that has been whitelisted will have no effect.
List blacklisted emails
Retrieves your email rejection blacklist. You can provide an email address to limit the results. Returns up to 1000 results. By default, entries that have expired are excluded from the results; set include_expired to true to include them.
Delete email from blacklist
Deletes an email rejection. There is no limit to how many rejections you can remove from your blacklist, but keep in mind that each deletion has an affect on your reputation.
Manage or get information about your sending domains.
List account senders
Return the senders that have tried to use this account.
List sender domains
Returns the sender domains that have been added to this account.
Add sender domain
Adds a sender domain to your account. Sender domains are added automatically as you send, but you can use this call to add them ahead of time.
Check domain settings
Checks the SPF and DKIM settings for a domain. If you haven't already added this domain to your account, it will be added automatically.
Sends a verification email in order to verify ownership of a domain. Domain verification is a required step to confirm ownership of a domain. Once a domain has been verified in a Transactional API account, other accounts may not have their messages signed by that domain unless they also verify the domain. This prevents other Transactional API accounts from sending mail signed by your domain.
Get sender info
Return more detailed information about a single sender, including aggregates of recent stats.
View sender history
Return the recent history (hourly stats for the last 30 days) for a sender.
Manage your subaccounts, including the abilitiy to pause and resume sending.
Get the list of subaccounts defined for the account, optionally filtered by a prefix.
Add a new subaccount.
Get subaccount info
Given the ID of an existing subaccount, return the data about it.
Update an existing subaccount.
Delete an existing subaccount. Any email related to the subaccount will be saved, but stats will be removed and any future sending calls to this subaccount will fail.
Pause a subaccount's sending. Any future emails delivered to this subaccount will be queued for a maximum of 3 days until the subaccount is resumed.
Resume a paused subaccount's sending.
List, delete, or get information on your Tags and their sending statistics.
Return all of the user-defined tag information.
Deletes a tag permanently. Deleting a tag removes the tag from any messages that have been sent, and also deletes the tag's stats. There is no way to undo this operation, so use it carefully.
Get tag info
Return more detailed information about a single tag, including aggregates of recent stats.
View tag history
Return the recent history (hourly stats for the last 30 days) for a tag.
View all tags history
Return the recent history (hourly stats for the last 30 days) for all tags.
Manage the Templates in your account.
Add a new template.
Get template info
Get the information for an existing template.
Update the code for an existing template. If null is provided for any fields, the values will remain unchanged.
Publish template content
Publish the content for the template. Any new messages sent using this template will start using the content that was previously in draft.
Delete a template.
Return a list of all the templates available to this user.
Get template history
Return the recent history (hourly stats for the last 30 days) for a template.
Render html template
Inject content and optionally merge fields into a template, returning the HTML that results.
Manage your tracking domains. Some of these endpoints may be deprecated.
List most clicked urlsdeprecated
Get the 100 most clicked URLs.
Search most clicked urlsdeprecated
Return the 100 most clicked URLs that match the search query given.
Get url historydeprecated
Return the recent history (hourly stats for the last 30 days) for a URL
List tracking domains
Get the list of tracking domains set up for this account.
Add tracking domains
Add a tracking domain to your account.
Check cname settings
Checks the CNAME settings for a tracking domain. The domain must have been added already with the add-tracking-domain call.
Get information about your account, or ping Transactional.
Get user info
Return the information about the API-connected user.
Validate an API key and respond to a ping.
Validate an API key and respond to a ping (JSON parser version).
List account senders
Return the senders that have tried to use this account, both verified and unverified.
Manage the webhooks in your account.
Get the list of all webhooks defined on the account.
Add a new webhook.
Get webhook info
Given the ID of an existing webhook, return the data about it.
Update an existing webhook.
Delete an existing webhook.
Add, list, or delete from your Rejection Allowlist.
Add email to whitelist
Adds an email to your email rejection whitelist. If the address is currently on your blacklist, that blacklist entry will be removed automatically.
List whitelisted emails
Retrieves your email rejection whitelist. You can provide an email address or search prefix to limit the results. Returns up to 1000 results.
Remove email from whitelist
Removes an email address from the whitelist.