Pause or resume a signal

Pause a signal so it stops sweeping, or resume it. Pausing keeps the people it already found.

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

Path parameters

signal_idstringrequired
The signal'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

statusstringrequired
active resumes; paused stops the sweep.activepaused

Request

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

Response

{
  "data": {
    "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
    "name": "Route optimisation chatter",
    "kind": "keyword_engagement",
    "status": "paused",
    "next_run_at": null
  }
}

Was this page helpful?