Remove contacts from a list

Take contacts off a static list. Send the ids as a JSON body or as a comma-separated contact_ids query parameter. The contacts themselves are untouched.

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

Path parameters

list_idstringrequired
The static list's id.

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 500 a call.

Request

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

Response

{
  "data": {
    "list": {
      "id": "5e6f7a8b-1c2d-4e3f-9a0b-1c2d3e4f5a6b",
      "name": "Trade show — Sept"
    },
    "removed": 2
  }
}

Was this page helpful?