Répertorier les campagnes et Canvas planifiés à venir

Utilisez cet endpoint pour renvoyer une liste JSON d’informations sur les campagnes planifiées et les Canvas d’entrée entre maintenant et un end_time désigné spécifié dans la requête.

Les messages quotidiens et récurrents n’apparaîtront qu’une seule fois avec leur prochaine occurrence. Les résultats renvoyés par cet endpoint comprennent les campagnes et les Canvas créés et planifiés dans le tableau de bord de Braze.

Conditions préalables

Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation messages.schedule_broadcasts.

Limite de débit

La limite de débit par défaut de Braze de 250 000 requêtes par heure s’applique à cet endpoint, comme documenté dans Limites de débit de l’API.

Paramètres de requête

Exemple de requête

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'

Réponse

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
    }
  ]
}