Delete Scheduled Messages
post
/messages/schedule/delete
The delete scheduled messages endpoint allows you to cancel a message that you previously scheduled before it has been sent.
important:
Looking for the api_key parameter?
As of May 2020, Braze has changed how we read API keys to be more secure. Now API keys must be passed as a request header, please see YOUR_REST_API_KEY within the Example Request below.
Braze will continue to support the api_key being passed through the request body and URL parameters, but will eventually be sunset. Please update your API calls accordingly.
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) |
Request Components
Example Request
1
2
3
4
5
6
7
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": "248762133332"
}
'
Edit this page on GitHub