Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Path Parameters

contactId
string
required

The contact id.

Minimum string length: 1

Query Parameters

locationId
string
required

The sub-account. It is the only thing that identifies the tenant on these routes, and it is re-checked against your access on every call. A sub-account that keeps its contacts in a CRM answers 400.

Body

application/json

The new state, and why.

doNotCall
boolean
required
Example:

true

reason
string
Maximum string length: 500
Example:

"Asked us not to call again."

{key}
any

Response

The contact, carrying its do-not-call state.

success
boolean
required
data
object
required

One person a CRM-less sub-account calls. Deliberately the minimum a dial needs: who they are, how to reach them, what zone they are in, whether they have asked not to be called, plus whatever fields the sub-account defines.

{key}
any