Query for the opt-out statuses for a list of identifiers and a given opt-out action type

POST

/v1/opt-out-statuses

Request Authorization

In your request headers, pass authorization: Bearer <<token>>.

If you're self-hosting Sombra, also add the request header x-sombra-authorization: Bearer <<sombraInternalKey>>. You can read more about request authorization here.

Requires scope:

View Opt Out Status

Header Parameters

authorizationstring
An API key generated from the Transcend dashboard: https://app.transcend.io/infrastructure/api-keys.
x-sombra-authorizationstring
The Sombra internal key. This header is only needed for self-hosted Sombra gateways. See https://docs.transcend.io/docs/dsr-automation/api-integration/authentication#authenticating-to-sombra
content-typestring
Specify content-type: application/json for a JSON response from the Transcend API.

Request Body

application/json

identifiersarray<object>
List of identifiers
actionTypestringenum:"AUTOMATED_DECISION_MAKING_OPT_OUT" | "USE_OF_SENSITIVE_INFORMATION_OPT_OUT" | "CONTACT_OPT_OUT" | "SALE_OPT_OUT" | "TRACKING_OPT_OUT" | "CUSTOM_OPT_OUT"

Request Body Examples

Query for tracking opt-out status:

{
  "identifiers": [
    {
      "identifier": "no-track@example.com",
      "identifierType": "email"
    },
    {
      "identifier": "pls-no-track@example.com",
      "identifierType": "email"
    }
  ],
  "actionType": "TRACKING_OPT_OUT"
}

Query for custom opt-out status:

{
  "identifiers": [
    {
      "identifier": "no-track@example.com",
      "identifierType": "email"
    }
  ],
  "actionType": "CUSTOM_OPT_OUT"
}

Response

200 (OK)

application/json

Returns a list of opt-out statuses for the different identifiers

Response Body

statusesarray<object>(required)

Response Body Example

Sample response body:

{
  "statuses": [
    {
      "identifier": "no-track@example.com",
      "identifierType": "email",
      "isOptedOut": false
    },
    {
      "identifier": "pls-no-track@example.com",
      "identifierType": "email",
      "isOptedOut": true
    }
  ]
}

400 (Bad Request)

application/json

While this request passed authentication, the input is malformed. Please double-check that your code conforms to our API specification.

401 (Unauthorized)

application/json

There was a problem authenticating your request. This may be an issue with the Transcend API key ("authorization" header), or the Sombra API key ("x-sombra-authorization" header used for self-hosted gateways only).

413 (Request Entity Too Large)

application/json

The request body is too large. JSON and raw bodies must be less than 50MB. URL encoded bodies must be less than 30MB.

429 (Too Many Requests)

application/json

You are sending requests too quickly and have hit our rate limit. If you hit this, you'll need to throttle your request velocity or try again later.

500 (Internal Server Error)

application/json

A 5xx error means there is either an issue with your self-hosted gateway, or a Transcend server is having issues. You check our system status at status.transcend.io. Please reach out to Transcend support if you're experiencing this error.

502 (Bad Gateway)

application/json

An upstream service on Transcend's side is having issues. You check our system status at status.transcend.io. Please reach out to Transcend support if you're experiencing this error.