Set native contact do-not-call
Stops this contact being dialled, or allows calls again.
doNotCall: true stops future calls, including a waiting callback. A call in progress is not ended. reason is kept with the stop. When the contact had already asked not to be called, a later stop keeps their own words and the date they asked.
doNotCall: false clears the switch, every stop the shared do-not-call list holds for the contact, and the contact’s waiting calls. Calls start again only when the contact is next enrolled.
The switch lives on the contact, so it holds for campaign and cadence calls. A test call your team starts turns it off first.
Clearing it works in one of two ways. A contact your team switched off clears with doNotCall: false alone. A contact who asked not to be called (doNotCallRequested on the contact) is refused with 409, and nothing is written, until the same call is repeated with acknowledgeRequest: true. The 409 carries requestedAt, which is null when the date was not recorded. Do not invent a date for it.
Cookie-auth callers must send the x-csrf-token header.
Required API key scope: contacts:write.
Authorizations
Query Parameters
Body
The new state, and why.
Response
The contact, carrying its do-not-call state.
