Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

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 contacts to stop calling, and why.

contactIds
string[]
required

The contacts to stop calling. Up to 100 per request.

Required array length: 1 - 100 elements
reason
string

Kept with the decision on every contact named. Worth sending: it is what tells the next person why.

Maximum string length: 500
{key}
any

Response

How many stopped, and which ones could not.

success
boolean
required
data
object
required
{key}
any