Delete a contact

Permanently delete one contact with their conversations, messages and queued steps. Suppression rows are kept: deleting somebody who opted out does not make them contactable again.

DELETEhttps://app.trygtm.com/api/v1/contacts/{contact_id}
Scope
write

Path parameters

contact_idstringrequired
The id of the one to act on.

Headers

Idempotency-Keystringoptional
A key unique to this write, up to 255 characters. A retry carrying the same key returns the first response instead of running again. Kept for 24 hours.

Request

curl -X DELETE https://app.trygtm.com/api/v1/contacts/8f2a91c4-6d1e-4c0a-9a57-2f3b1c7e9d10 \
  -H "Authorization: Bearer $TRYGTM_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

Response

{
  "data": {
    "deleted": 1,
    "contact_ids": [
      "8f2a91c4-6d1e-4c0a-9a57-2f3b1c7e9d10"
    ]
  }
}

Was this page helpful?