Listar próximas Campaigns e Canvas agendados

Use este endpoint para retornar uma lista JSON de informações sobre Campaigns agendadas e Canvas de entrada entre agora e um end_time designado especificado na solicitação.

Mensagens diárias e recorrentes aparecerão apenas uma vez com sua próxima ocorrência. Os resultados retornados neste endpoint incluem Campaigns e Canvas criados e agendados no dashboard da Braze.

Pré-requisitos

Para usar este endpoint, você precisará de uma chave de API com a permissão messages.schedule_broadcasts.

Limite de taxa

Aplicamos o limite de taxa padrão da Braze de 250.000 solicitações por hora a esse endpoint, conforme documentado em Limites de taxa da API.

Parâmetros de solicitação

Exemplo de solicitação

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'

Resposta

1
2
3
4
5
6
7
8
9
10
11
12
{
  "scheduled_broadcasts": [
    {
      "name": (string) the name of the scheduled broadcast,
      "id": (stings) the Canvas or campaign identifier,
      "type": (string) the broadcast type either Canvas or Campaign,
      "tags": (array) an array of tag names formatted as strings,
      "next_send_time": (string) The next send time formatted in ISO 8601, may also include time zone if not local/intelligent delivery,
      "schedule_type": (string) The schedule type, either local_time_zones, intelligent_delivery or the name of your company's time zone
    }
  ]
}