Documentation
Sign inGet started

Cancel a scheduled message

POST
/v1/email/messages/{message_id}/cancel
curl -X POST "https://us1.platform.bird.com/v1/email/messages/{message_id}/cancel" \
  -H "Authorization: Bearer $TOKEN"
Cancels a message that was scheduled with scheduled_at before it sends. Only a message that is still scheduled can be canceled; a message that already started sending, was delivered, or was previously canceled returns a conflict error. The message's status becomes canceled and an email.canceled webhook event fires. Canceling does not return consumed scheduled-send quota.
Parametri
message_id
string
Message ID.