Get suppressions
This method retrieves the suppressions for domains that are owned or have permissions granted.
Please log in to see full path URL. Learn why.
get
/email/1/suppressions
Authorizations:
Scopes:
Request rate limit:
100 requests / second (per account)
query Parameters
domainName required | string Name of the requested domain. |
type required | string Enum: "BOUNCE" "COMPLAINT" "OVER_QUOTA" Type of suppression. |
emailAddress | string Email address that is suppressed. |
recipientDomain | string Recipient domain that is suppressed. |
createdDateFrom | string <date-time> Start date for searching suppressions. |
createdDateTo | string <date-time> End date for searching suppressions. |
page | integer >= 0 Default: 0 Requested page number. |
size | integer [ 1 .. 1000 ] Default: 100 Requested page size. |
Responses
200
OK
400
Bad request
401
Unauthorized
403
Forbidden
429
Too Many Requests
500
Internal Server Error
Request samples
- cURL
- Java
- C#
- Go
- Python
- PHP
- JavaScript
- NodeJs
- Ruby
Example
cURL
Copy
curl -L -g 'https://{baseUrl}/email/1/suppressions?domainName=%7BdomainName%7D&type=%7Btype%7D' \ -H 'Authorization: {authorization}' \ -H 'Accept: application/json'
Response samples
- 200
- 400
- 401
- 403
- 429
- 500
Content type
application/json
Copy
Collapse all {- "results": [
- {
- "domainName": "example.com",
- "emailAddress": "jane.smith@example.org",
- "type": "BOUNCE",
- "createdDate": "2024-08-14T14:02:17.366Z",
- "reason": "550 5.1.1 <jane.smith@example.org>: user does not exist"
}
], - "paging": {
- "page": 0,
- "size": 100
}
}
Need assistance
Encountering issues
What's new? Check out
Unsure about a term? See