Geplante API-getriggerte Canvases aktualisieren

Verwenden Sie diesen Endpunkt, um geplante, API-getriggerte Canvases zu aktualisieren, die im Dashboard erstellt wurden.

So können Sie festlegen, welche Aktion den Versand der Nachricht triggern soll. Sie können trigger_properties übergeben, die Braze in die Nachricht selbst einfügt.

Beachten Sie, dass Sie zum Versenden von Nachrichten über diesen Endpunkt eine Canvas-ID benötigen, die beim Erstellen eines Canvas generiert wird.

Jeder Zeitplan überschreibt den Zeitplan, den Sie in der ursprünglichen Anfrage zum Erstellen des Zeitplans oder in früheren Anfragen zum Aktualisieren des Zeitplans angegeben haben, vollständig.

• Wenn Sie z. B. ursprünglich "schedule" : {"time" : "2015-02-20T13:14:47", "in_local_time" : true} angeben und dann in Ihrem Update "schedule" : {"time" : "2015-02-20T14:14:47"} übergeben, sendet Braze Ihre Nachricht zur angegebenen Zeit in UTC, nicht in der Ortszeit der Nutzer:innen.
• Geplante Trigger, die Sie kurz vor oder während des vorgesehenen Sendezeitpunkts aktualisieren, werden nach bestem Bemühen aktualisiert, sodass Braze möglicherweise in letzter Sekunde Änderungen an allen, einigen oder keinen Ihrer Zielnutzer:innen vornimmt.

Voraussetzungen

Um diesen Endpunkt zu verwenden, benötigen Sie einen API-Schlüssel mit der Berechtigung canvas.trigger.schedule.update.

Rate-Limit

Wir wenden auf diesen Endpunkt das standardmäßige Braze-Rate-Limit von 250.000 Anfragen pro Stunde an, wie in API-Rate-Limits dokumentiert.

Anfragetext

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

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

Anfrageparameter

Beispielanfrage

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