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 these contacts belong to. Your access to it is checked on every call. A sub-account with a CRM answers 400.

Body

application/json

The new state, and why.

doNotCall
boolean
required

True stops future calls to this contact, including a waiting callback. A call in progress is not ended. False allows calls again.

Example:

true

reason
string

Why, up to 500 characters. Kept only when doNotCall is true.

Maximum string length: 500
Example:

"Asked us not to call again."

requested
boolean

Set this when the person asked not to be called, not when your team switched them off. It is kept with the decision, and clearing the block later then needs acknowledgeRequest.

acknowledgeRequest
boolean

Required to send doNotCall: false for a contact who asked not to be called. Without it the call is refused with 409 and nothing is written. Sending it records that the decision to call them again was deliberate, and leaves a note saying so on the contact.

{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