スケジュールされた API トリガーキャンバスを更新

このエンドポイントを使用して、ダッシュボードで作成されたスケジュールされた API トリガーキャンバスを更新します。

これにより、メッセージの送信をトリガーするアクションを決定できます。これをメッセージ自体にテンプレートとして渡すことができます。trigger_properties

このエンドポイントでメッセージを送信するには、キャンバスの作成時に作成された Canvas ID が必要であることに注意してください。

どのスケジュールでも、スケジュールの作成リクエストまたは以前のスケジュールの更新リクエストで指定したスケジュールが完全に上書きされます。 -たとえば、"schedule" : {"time" : "2015-02-20T13:14:47", "in_local_time" : true}最初に提供した後で更新を行った場合"schedule" : {"time" : "2015-02-20T14:14:47"}、メッセージはユーザーの現地時間ではなく、UTC で指定された時刻に送信されるようになりました。 -スケジュールされたトリガーが、送信予定時刻のすぐ近く、または送信予定時刻の間に更新された場合、最善を尽くして更新されるため、最後の瞬間の変更がターゲットユーザーのすべてまたは一部に適用されたり、まったく適用されなかったりする可能性があります。

前提条件

このエンドポイントを使用するには、canvas.trigger.schedule.update権限のある API キーが必要です。

レート制限

We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.

リクエスト本文

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

リクエストパラメーター

リクエスト例

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