Update Scheduled Messages
post
/messages/schedule/update
The messages update schedule endpoint accepts updates to either the schedule or messages parameter or both. Your request must contain at least one of those two keys.
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
4
5
6
7
8
9
{
"schedule_id": (required, string) the schedule_id to update (obtained from the response to create schedule),
"schedule": {
// optional, see create schedule documentation
},
"messages": {
// optional, see available messaging objects documentation
}
}
Request Parameters
| Parameter | Required | Data Type | Description |
|---|---|---|---|
schedule_id |
Required | String | The schedule_id to update (obtained from the response to create schedule) |
schedule |
Optional | Object | See Schedule Object |
messages |
Optional | Object | See Available Message Object |
Request Components
Available Messaging Objects
You can use these objects in the request body above.
- Android Objects
- Apple Objects
- Content Cards Object
- Email Object
- Kindle or FireOS Object
- SMS Object
- Web Objects
- Webhook Object
- Windows Objects
Request Example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
curl --location --request POST 'https://rest.iad-01.braze.com/messages/schedule/update' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
"schedule_id": "schedule identifier",
"schedule": {
"time": "2017-05-24T20:30:36Z"
},
"messages": {
"apple_push": {
"alert": "Updated Message!",
"badge": 1
},
"android_push": {
"title": "Updated title!",
"alert": "Updated message!"
},
"sms": {
"subscription_group_id": "23894012",
"message_variation_id": "3728490",
"body": "This is my SMS body.",
"app_id": "sdj23-234bd-23bdjask"
}
}
}'
Edit this page on GitHub