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
Required Scopes
The access token received from the authorization server in the OAuth 2.0 flow.
The contact's email address.
The channel type for the subscription type. Currently, the only supported channel type is EMAIL.
EMAIL If you have the business unit add-on, include this parameter to filter results by business unit ID. The default Account business unit will always use 0.
Set to true to include the details of the updated subscription statuses in the response. Not including this parameter will result in an empty 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.