POST/broadcasts/{id}/cancel

Cancel a broadcast

Cancels a queued or scheduled broadcast. Cancelling a queued broadcast stops further delivery, but does not affect emails that have already been sent.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter
idstringrequired
The UUID of the broadcast to cancel.

1 status code
200Returns an object containing the broadcast identifier and the response object type.
idstringoptional
The ID of the broadcast.
objectstringoptional
The object type of the response.

Error handling

The id path parameter must be a valid UUID identifying the broadcast you want to cancel. The broadcast must be queued or scheduled to match the documented cancellation behavior.