Skip to content

Get upcoming scheduled campaigns and Canvases

get

/messages/scheduled_broadcasts

You can view a JSON list of upcoming and scheduled campaigns and Canvases using the following information and parameters. The endpoint will return information about scheduled campaigns and entry Canvases between now and the designated end_time specified in the request. Daily, recurring messages will only appear once with their next occurrence. Results returned in this endpoint are only for campaigns and Canvases created and scheduled in Braze.

See me in Postman

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 parameters

Parameter Required Data Type Description
end_time Required String in ISO-8601 format End date of the range to retrieve upcoming scheduled campaigns and Canvases. This is treated as midnight in UTC time by the API.

Example request

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/messages/scheduled_broadcasts?end_time=2018-09-01T00:00:00-04:00' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
  "scheduled_broadcasts": [
    # Example Canvas
    {
      "name" => String,
      "id" => String,
      "type" => "Canvas",
      "tags" => [String tag names],
      "next_send_time" => "YYYY-MM-DD HH:mm:ss" (may also include time zone if not local/intelligent delivery)
      "schedule_type" => one of "local_time_zones", "intelligent_delivery", or the name of your company's time zone
    },
    # Example Campaign
    {
      "name" => String,
      "id" => String,
      "type" => "Campaign",
      "tags" => [String tag names],
      "next_send_time" => "YYYY-MM-DD HH:mm:ss" (may also include time zone if not local/intelligent delivery)
      "schedule_type" => one of "local_time_zones", "intelligent_delivery", or the name of your company's time zone
    },
  ]
}
  Edit this page on GitHub
WAS THIS PAGE HELPFUL?
New Stuff!