Delete scheduled messages
Use this endpoint to cancel a message that you previously scheduled before it has been sent.
Rate limit
We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.
Request body
1
2
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
1
2
3
{
"schedule_id": (required, string) the `schedule_id` to delete (obtained from the response to create schedule)
}
Request parameters
Parameter | Required | Data Type | Description |
---|---|---|---|
schedule_id |
Required | String | The schedule_id to delete (obtained from the response to create schedule). |
Example request
1
2
3
4
5
6
curl --location --request POST 'https://rest.iad-01.braze.com/messages/schedule/delete' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
"schedule_id": "schedule_identifier"
}'