Send Messages

Cancel a scheduled broadcast

Changed on

Cancel a trigger you scheduled with scheduled_at, before it fires.

The request fails if the broadcast has started calculating its audience, is already sending, or has already sent. A trigger with a rate_limit is the exception: you can cancel it while it sends. Canceling stops more people from entering the broadcast, and people who already entered continue through your workflow.

post/v1/campaigns/{broadcast_id}/triggers/{trigger_id}/cancel

Request

  • Base URL
    https://api.customer.io
  • Auth
    HTTP bearer

Path parameters

broadcast_idinteger required
Example:3

The ID of the broadcast you triggered.

trigger_idinteger required
Example:12

The ID of the trigger you want to cancel. You get it back from the trigger request that scheduled the send.

Response

The trigger was canceled. Returns the trigger's current state.

Example response

{
  "trigger": {
    "id": 12,
    "broadcast_id": 3,
    "created_at": 1796040000,
    "scheduled_at": 1796128200,
    "cancelled_at": 1796041200,
    "rate_limit": {
      "rate": 1000,
      "period": "hour"
    }
  }
}

Changes