This endpoint allows you to create an SSO integration.

This endpoint allows you to delete an IdP configuration by ID.

You can retrieve the IDs for your configurations from the response provided by the “Get All SSO Integrations” endpoint.

This endpoint allows you to retrieve an SSO integration by ID.

You can retrieve the IDs for your configurations from the response provided by the “Get All SSO Integrations” endpoint.

This endpoint allows you to modify an exisiting SSO integration.

You can retrieve the IDs for your configurations from the response provided by the “Get All SSO Integrations” endpoint.

This endpoint allows you to create an SSO Teammate.

The email provided for this user will also function as the Teammate’s username.

This endpoint allows you to modify an existing SSO Teammate.

To turn a teammate into an admin, the request body should contain the is_admin field set to true. Otherwise, set is_admin to false and pass in all the scopes that a teammate should have.

Only the parent user and Teammates with admin permissions can update another Teammate’s permissions. Admin users can only update permissions.

This endpoint allows you to delete your spam reports.

Deleting a spam report will remove the suppression, meaning email will once again be sent to the previously suppressed address. This should be avoided unless a recipient indicates they wish to receive email from you again. You can use our bypass filters to deliver messages to otherwise suppressed addresses when exceptions are required.

There are two options for deleting spam reports:

1. You can delete all spam reports by setting the delete_all field to true in the request body.
2. You can delete a list of select spam reports by specifying the email addresses in the emails array of the request body.

This endpoint allows you to retrieve all spam reports.

This endpoint allows you to delete a specific spam report by email address.

Deleting a spam report will remove the suppression, meaning email will once again be sent to the previously suppressed address. This should be avoided unless a recipient indicates they wish to receive email from you again. You can use our bypass filters to deliver messages to otherwise suppressed addresses when exceptions are required.

This endpoint allows you to retrieve a specific spam report by email address.

This endpoint allows you to retrieve your email statistics segmented by browser type.

We only store up to 7 days of email activity in our database. By default, 500 items will be returned per request via the Advanced Stats API endpoints.

Advanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our Statistics Overview.

This endpoint allows you to retrieve your email statistics segmented by client type.

We only store up to 7 days of email activity in our database. By default, 500 items will be returned per request via the Advanced Stats API endpoints.

Advanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our Statistics Overview.

This endpoint allows you to retrieve your email statistics segmented by a specific client type.

We only store up to 7 days of email activity in our database. By default, 500 items will be returned per request via the Advanced Stats API endpoints.

Available Client Types

• phone
• tablet
• webmail
• desktop

Advanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our Statistics Overview.

This endpoint allows you to retrieve your email statistics segmented by the device type.

We only store up to 7 days of email activity in our database. By default, 500 items will be returned per request via the Advanced Stats API endpoints.

Available Device Types

| Device | Description | Example |
|—|—|—|
| Desktop | Email software on desktop computer. | I.E., Outlook, Sparrow, or Apple Mail. |
| Webmail | A web-based email client. | I.E., Yahoo, Google, AOL, or Outlook.com. |
| Phone | A smart phone. | iPhone, Android, Blackberry, etc.
| Tablet | A tablet computer. | iPad, android based tablet, etc. |
| Other | An unrecognized device. |

Advanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our Statistics Overview.

This endpoint allows you to retrieve your email statistics segmented by country and state/province.

We only store up to 7 days of email activity in our database. By default, 500 items will be returned per request via the Advanced Stats API endpoints.

Advanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our User Guide.

This endpoint allows you to retrieve your email statistics segmented by recipient mailbox provider.

We only store up to 7 days of email activity in our database. By default, 500 items will be returned per request via the Advanced Stats API endpoints.

Advanced Stats provide a more in-depth view of your email statistics and the actions taken by your recipients. You can segment these statistics by geographic location, device type, client type, browser, and mailbox provider. For more information about statistics, please see our Statistics Overview.

This endpoint allows you to retrieve all of your global email statistics between a given date range.

Parent accounts will see aggregated stats for their account and all subuser accounts. Subuser accounts will only see their own stats.

This endpoint allows you to retrieve the email statistics for the given subusers.

You may retrieve statistics for up to 10 different subusers by including an additional subusers parameter for each additional subuser.

This endpoint allows you to retrieve the monthly email statistics for all subusers over the given date range.

When using the sort_by_metric to sort your stats by a specific metric, you can not sort by the following metrics:
bounce_drops, deferred, invalid_emails, processed, spam_report_drops, spam_reports, or unsubscribe_drops.

This endpoint allows you to retrieve the total sums of each email statistic metric for all subusers over the given date range.

This endpoint allows you to retrive the monthly email statistics for a specific subuser.

When using the sort_by_metric to sort your stats by a specific metric, you can not sort by the following metrics:
bounce_drops, deferred, invalid_emails, processed, spam_report_drops, spam_reports, or unsubscribe_drops.

This endpoint allows you to retrieve a list of all of your subusers.

You can choose to retrieve specific subusers as well as limit the results that come back from the API.

This endpoint allows you to create a new subuser.

This endpoint allows you to request the reputations for your subusers.

Subuser sender reputations give a good idea how well a sender is doing with regards to how recipients and recipient servers react to the mail that is being received. When a bounce, spam report, or other negative action happens on a sent email, it will affect your sender rating.

This endpoint allows you to delete a subuser.

This is a permanent action. Once deleted, a subuser cannot be retrieved.

This endpoint allows you to enable or disable a subuser.

This endpoint allows you update your subusers’ assigned IP.

Each subuser should be assigned to an IP address from which all of this subuser’s mail will be sent. Often, this is the same IP as the parent account, but each subuser can have one or more of their own IP addresses as well.

More information:

• How to request more IPs
• Setup Reverse DNS

This endpoint allows you to add one or more email addresses to the global suppressions group.

This endpoint allows you to remove an email address from the global suppressions group.

Deleting a suppression group will remove the suppression, meaning email will once again be sent to the previously suppressed addresses. This should be avoided unless a recipient indicates they wish to receive email from you again. You can use our bypass filters to deliver messages to otherwise suppressed addresses when exceptions are required.

This endpoint allows you to retrieve a global suppression. You can also use this endpoint to confirm if an email address is already globally suppresed.

If the email address you include in the URL path parameter {email} is already globally suppressed, the response will include that email address. If the address you enter for {email} is not globally suppressed, an empty JSON object {} will be returned.

This endpoint allows you to retrieve a list of all email address that are globally suppressed.

This endpoint allows you to retrieve all suppressed email addresses belonging to the given group.

This endpoint allows you to add email addresses to an unsubscribe group.

If you attempt to add suppressions to a group that has been deleted or does not exist, the suppressions will be added to the global suppressions list.

This endpoint allows you to search a suppression group for multiple suppressions.

When given a list of email addresses and a group ID, this endpoint will only return the email addresses that have been unsubscribed from the given group.

This endpoint allows you to remove a suppressed email address from the given suppression group.

Removing an address will remove the suppression, meaning email will once again be sent to the previously suppressed addresses. This should be avoided unless a recipient indicates they wish to receive email from you again. You can use our bypass filters to deliver messages to otherwise suppressed addresses when exceptions are required.

This endpoint allows you to retrieve a list of all suppressions.

This endpoint returns a list of all groups from which the given email address has been unsubscribed.

This endpoint allows you to retrieve a list of all suppression groups created by this user.

This endpoint can also return information for multiple group IDs that you include in your request. To add a group ID to your request, simply append ?id=123456&id=123456, with the appropriate group IDs.

This endpoint allows you to create a new suppression group.

To add an email address to the suppression group, create a Suppression.

This endpoint allows you to delete a suppression group.

If a recipient uses the “one-click unsubscribe” option on an email associated with a deleted group, that recipient will be added to the global suppression list.

Deleting a suppression group will remove the suppression, meaning email will once again be sent to the previously suppressed addresses. This should be avoided unless a recipient indicates they wish to receive email from you again. You can use our bypass filters to deliver messages to otherwise suppressed addresses when exceptions are required.

This endpoint allows you to retrieve a single suppression group.

This endpoint allows you to update or change a suppression group.

This endpoint allows you to retrieve a list of all recent access requests.

The Response Header’s link parameter will include pagination info.

This endpoint allows you to deny an attempt to access your account.

Note: Only teammate admins may delete a teammate’s access request.

This endpoint allows you to approve an access attempt.

Note: Only teammate admins may approve another teammate’s access request.

This endpoint allows you to retrieve a list of all current Teammates.

You can limit the number of results returned using the limit query paramater. To return results from a specific Teammate, use the offset paramter. The Response Headers will include pagination info.