Retrieve a contact's unsubscribed status
Check whether a contact has unsubscribed from all email subscriptions. If a contact has not opted out of all communications, the response results array will be empty.
Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The unique identifier of the subscriber whose unsubscribe status is being retrieved.
Query Parameters
The communication channel for which the unsubscribe status is being checked. Must be 'EMAIL'.
EMAIL An optional integer representing the business unit ID.
A boolean indicating whether to include detailed information. Defaults to false.
Response
successful operation
The date and time when the operation was completed.
An array containing the results of the operation.
The date and time when the operation started.
The current status of the operation, which can be PENDING, PROCESSING, CANCELED, or COMPLETE.
CANCELED, COMPLETE, PENDING, PROCESSING An array of error objects detailing any issues encountered during the operation.
An object containing related links, where each key is a link name and each value is a URL.
The number of errors encountered during the operation.
The date and time when the request was made.