Download OpenAPI specification:Download
All API endpoints require authentication. To become authenticated you will need your Optizmo API key which is found on the SUPPRESS Account Settings page.
The API key needs to be sent with every request as an Authorization
header:
Authorization: Bearer <API key>
API endpoints are rate limited to ensure stable and fair access to the API.
Refer to the x-rate-limit-limit
, x-rate-limit-remaining
, and x-rate-limit-reset
response headers for rate limit information.
API endpoints should respond almost immediately. Where long-running processing are started (e.g. Preparing a list for download) a complementary method is provided for checking the process status.
Lists that contain a collection of all emails/phone numbers/hashes of users who have opted out.
Starts preparing a list for download and immediately returns a link to where the download will be available.
NOTE The download link will return a 404 NOT FOUND
response until the file is ready. The time it takes to
prepare the download is not constant and may take up to 10 minutes for it to be available. Continue to poll the
download link until it returns the file.
Authorization required | any Your API key used to authenticate the request |
Details of what should be included in the list download file.
optoutListId required | string The Opt-Out list id, which can be found on the Opt-Out list page under Opt-Out List Details |
columns required | Array of strings Items Enum: "plain" "hashed" "timestamp" "campaign" "ip" Specifies which columns should appear in the exported file
|
collectionType required | Array of strings Items Enum: "collected" "imported" Specifies which optouts should appear in the download based on how they were collected
|
object Excludes opt-outs that were received outside of the specified date parameters. | |
domainFilter | string Only include optouts from matching domain names. Enter the last part (root domain) of the domain name(s) you want to restrict optouts to, with multiple domains separated by commas. |
{- "optoutListId": "901fad4c46a1e723",
- "columns": [
- "plain"
], - "collectionType": [
- "collected"
], - "dateRange": {
- "from": "2021-07-30",
- "to": "2021-12-13"
}, - "domainFilter": "gmail.com, co.uk"
}
Generates a URL that a file of Opt-Outs can be uploaded to, in order to add them to an existing Opt-Out list
Authorization required | any Your API key used to authenticate the request |
Details of what should be included in the list upload file.
optoutListId required | string The Opt-Out list id, which can be found on the Opt-Out list page under Opt-Out List Details |
fileContentLength required | number The size of the Opt-Out file in bytes. The size cannot exceed 5gb. |
{- "optoutListId": "901fad4c46a1e723",
- "fileContentLength": 536870912
}
{- "importReference": "a405108f-284c-4059-8817-459bfcbcdd9a"
}
Fetches the current status of an optout-list upload
reference required | any Reference returned from the request to |
Authorization required | any Your API key used to authenticate the request |
{- "status": "running",
- "message": "string",
- "elapsedSeconds": 0,
- "addedCount": 0,
- "malformedCount": 0,
- "submittedCount": 0
}
Generates the download activity export and fetches the url to access the generated export. This is the same export available from the Suppress UI, except with a broader date range. The list is limited to Opt-Out Lists that were last downloaded between (inclusive) 0 and 90 days ago.
Authorization required | any Your API key used to authenticate the request |
Redirecting to <a href="https://.....</a>
Collects an optout to be processed and stored directly into an Opt-Out List.
Authorization required | any Your API key used to authenticate the request |
Details of what should be included in the list collect optout request.
optoutListId required | string The Opt-Out list id, which can be found on the Opt-Out list page under Opt-Out List Details |
email required | string An email to collect as an optout into an email list. |
{- "optoutListId": "901fad4c46a1e723",
- "sms": "12345678900"
}