Skip to main content
POST
/
dnc
/
communication-opt-outs
Add communication opt-outs
curl --request POST \
  --url https://api.altahq.com/v1/dnc/communication-opt-outs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identifiers": [
    {
      "identifier": "<string>",
      "name": "<string>"
    }
  ],
  "pauseActiveProspectWorkflows": true
}
'
{
  "error": "ValidationError",
  "message": "Invalid request body"
}
You can add up to 500 identifiers in a single request.

Authorizations

​
Authorization
string
header
required

API token authentication. Generate a token from the Alta dashboard and pass it as a Bearer token in the Authorization header.

Body

application/json
​
identifiers
object[]
required

Array of identifiers to add to the DNC list.

Maximum array length: 500
​
pauseActiveProspectWorkflows
boolean
default:true

Whether to pause active prospect workflows for matching prospects. Defaults to true.

Response

Identifiers added to the DNC list successfully