SUsuprsend

Cancel Broadcast

Changed on

API to cancel a running broadcast execution. You can cancel a broadcast by passing any combination of filters in the request body. When multiple parameters are provided, they are ANDed together to narrow down the matching broadcast runs.

For example, passing both list_id and idempotency_key will cancel only the broadcast runs that match both the given list and idempotency key.

post/v1/broadcast_run/cancel/

Request

Request body

execution_idstring

Unique execution identifier of the broadcast run to cancel. You can find this in the broadcast logs on the SuprSend dashboard.

list_idstring

Identifier of the user list whose broadcast runs should be cancelled.

idempotency_keystring

Idempotency key that was passed when triggering the broadcast. Use this to cancel a specific broadcast triggered with a known idempotency key.

Example request

{
  "execution_id": "broadcast_xxxx-xxxx-xxxx-xxxx",
  "list_id": "my_user_list",
  "idempotency_key": "a1b2c3d4-xxxx-xxxx-xxxx-ef0123456789"
}

Response

200 - OK

execution_idsstring[]

List of broadcast execution IDs that were successfully cancelled. Empty array if no matching broadcast runs were found.

Example response

{
  "execution_ids": [
    "broadcast_xxxx-xxxx-xxxx-xxxx"
  ]
}

Changes