/v1/comms/opt-outsAdd an address to the do-not-contact list
Lists one phone number or email address as do not contact, as the caller, with an optional reason; every later text, email, call and blast copy to it is refused. Body {address, reason}. The answer is the line in its one spelling (a number as E.164, a mailbox lower-cased); an address already listed answers the line that stands. Anything that is not a phone number or an email address is a 400. Use it when a person asks, in any words or on a call, not to be contacted.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
Request body
application/jsonrequiredResponses
the action's answer
{
"data": {
"address": "string",
"kind": "string",
"optedOutAt": "2026-01-01T00:00:00Z",
"optedOutBy": {
"accountId": "",
"name": "string"
},
"reason": "string",
"source": "string"
}
}a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}