Cancel queued steps

Cancel pending steps of one campaign so they never send, with an optional reason recorded on each.

POSThttps://app.trygtm.com/api/v1/queue/reject
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

campaignstringrequired
The campaign's id or exact name.
queue_idsstring[]required
Queued step ids from list_queued_steps, up to 200.
reasonstringoptional
Why, recorded on each step.

Request

curl -X POST https://app.trygtm.com/api/v1/queue/reject \
  -H "Authorization: Bearer $TRYGTM_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "campaign": "Q4 logistics leaders",
    "queue_ids": [
      "8f2a91c4-6d1e-4c0a-9a57-2f3b1c7e9d10"
    ]
  }'

Response

{
  "data": {
    "rejected": 1,
    "skipped": 0,
    "queue_ids": [
      "b1a2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d"
    ]
  }
}

Was this page helpful?