Unlabel contacts

Take one label off up to 5,000 contacts. The label itself stays in the workspace, because campaign steps may name it.

DELETEhttps://app.trygtm.com/api/v1/contacts/labels
Scope
write

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.

Body

contact_idsstring[]required
Contact ids, up to 5,000 a call. Read them from list_contacts.
label_idstringrequired
The label's id from list_labels.

Request

curl -X DELETE https://app.trygtm.com/api/v1/contacts/labels \
  -H "Authorization: Bearer $TRYGTM_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "contact_ids": [
      "8f2a91c4-6d1e-4c0a-9a57-2f3b1c7e9d10"
    ],
    "label_id": "8f2a91c4-6d1e-4c0a-9a57-2f3b1c7e9d10"
  }'

Response

{
  "data": {
    "label": {
      "id": "7c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
      "name": "Warm",
      "color": "graph-meeting"
    },
    "removed": 2
  }
}

Was this page helpful?