Skip to main content
DELETE
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Body

application/json

The project, and the contact identified by id or phone number.

Identify the contact by contactId, by phoneNumber, or by both. At least one is required. Around 2% of contacts carry no id and are reachable only by number.

locationId
string
required

Stable project location id used to tenant-scope the contact action.

Minimum string length: 1
Example:

"loc_abc123"

contactId
string
required

Stable contact id. Preferred when the contact has one.

Example:

"contact_123"

projectName
string

Optional display label. Never used as tenant identity.

Example:

"Acme Clinic"

phoneNumber
string

Contact phone number. Required when the contact has no id, and worth sending alongside one to reach records written before that id existed.

Example:

"+15551234567"

Response

Internal mark cleared successfully.

success
boolean
required
data
object
required