Mettre à jour les campagnes planifiées déclenchées par API

Utilisez cet endpoint pour mettre à jour des campagnes planifiées déclenchées par API et créées dans le tableau de bord, ce qui vous permet de décider quelle action doit déclencher le message à envoyer.

Vous pouvez indiquer les trigger_properties qui seront modélisées dans le message lui-même.

Notez que pour envoyer des messages avec ce point de terminaison, vous devez avoir un ID de campagne, créé lorsque vous construisez une campagne déclenchée par API.

Toute planification remplacera complètement celle que vous avez fournie dans la demande de création de planification ou dans les demandes de mise à jour de planification précédentes. Par exemple, si vous avez initialement fixé la planification à "schedule" : {"time" : "2015-02-20T13:14:47", "in_local_time" : true} et que vous l’avez ensuite mise à jour à "schedule" : {"time" : "2015-02-20T14:14:47"}, le message sera désormais envoyé à l’heure spécifiée en UTC, et non à l’heure locale de l’utilisateur.

Les déclencheurs planifiés qui sont mis à jour très près de l’heure à laquelle ils étaient censés être envoyés, ou pendant cette heure, seront mis à jour au mieux afin que les changements de dernière seconde puissent être appliqués à tous, à certains ou à aucun de vos utilisateurs ciblés. Les mises à jour ne sont pas appliquées si la planification d’origine utilisait l’heure locale et que l’heure d’origine est déjà passée dans n’importe quel fuseau horaire.

Conditions préalables

Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation campaigns.trigger.schedule.update.

Limite de débit

Nous appliquons la limitation du débit Braze par défaut de 250 000 requêtes par heure à cet endpoint, comme documenté dans Limites de débit de l’API.

Corps de la demande

1
2
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY

1
2
3
4
5
6
7
{
  "campaign_id": (required, string) see campaign identifier,
  "schedule_id": (required, string) the `schedule_id` to update (obtained from the response to create schedule),
  "schedule": {
    // required, see create schedule documentation
  }
}

Paramètres de demande

Exemple de demande

1
2
3
4
5
6
7
8
9
10
11
curl --location --request POST 'https://rest.iad-01.braze.com/campaigns/trigger/schedule/update' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "campaign_id": "campaign_identifier",
  "schedule_id": "schedule_identifier",
  "schedule": {
    "time": "2017-05-24T21:30:00Z",
    "in_local_time": true
  }
}'