Delete a signal

Delete a signal, its matches and any list built on it; the matched contacts stay. Answers 409 for a managed signal (pause it instead), one a campaign build was set up with, or one an automation starts on.

DELETEhttps://app.trygtm.com/api/v1/signals/{signal_id}
Scope
write

Path parameters

signal_idstringrequired
The signal's id, from list_signals.

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/signals/8f2a91c4-6d1e-4c0a-9a57-2f3b1c7e9d10 \
  -H "Authorization: Bearer $TRYGTM_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

Response

{
  "data": {
    "deleted": {
      "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
      "name": "Route optimisation chatter"
    },
    "matches_deleted": 42,
    "audiences_deleted": [],
    "campaigns_affected": [],
    "agents_stopped": []
  }
}

Was this page helpful?