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.

Rate limit

We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.

Braze endpoints support batching API requests. A single request to the messaging endpoints can reach any of the following:

  • Up to 50 specific external_ids, each with individual message parameters
  • A segment of any size created in the Braze dashboard, specified by its segment_id
  • An ad-hoc audience segment of any size, defined in the request as a Connected Audience object

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
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": "schedule_identifier"
}
'
WAS THIS PAGE HELPFUL?
New Stuff!