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.

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
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 objects, below.

Available messaging objects

You can use these objects in the request body above.

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": "subscription_group_identifier",
        "message_variation_id": "message_variation_identifier",
        "body": "This is my SMS body.",
        "app_id": "app_identifier"
      }
  }
}'
WAS THIS PAGE HELPFUL?
New Stuff!