Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Path Parameters

contactId
string
required

The contactId returned by List contacts. For contacts without one, use an encoded international phone number and idType=phone. This is not the list row id.

Minimum string length: 1

Body

application/json
locationId
string
required

The location ID of the sub-account that holds the contact. The contact is looked up only there.

Minimum string length: 1
doNotCall
boolean
required

True stops AI calls by adding a do-not-call tag in GoHighLevel. False removes the tag and clears the platform's do-not-call list for the contact.

idType
enum<string>

What contactId in the path is. contact, the default, is a contact ID. phone is an E.164 phone number.

Available options:
contact,
phone
acknowledgeRequest
boolean

Send true with doNotCall false when the contact asked not to be called. Without it, that change is refused with 409.

isInternal
boolean

True marks the contact as your own test contact, so its calls are left out of reporting. False clears the mark.

Response

Only requested flags and their action results are returned.

success
any
required
data
object
required
actionResults
object
required