スケジュールされたAPIトリガーCanvasesを更新する

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

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

このエンドポイントを使用してメッセージを送信するには、Canvasを構築するときに作成されたCanvas IDが必要です。

スケジュールは、スケジュール作成リクエストや以前のスケジュール更新リクエストで提供したものを完全に上書きします。

• たとえば、最初に"schedule" : {"time" : "2015-02-20T13:14:47", "in_local_time" : true}を指定し、更新で"schedule" : {"time" : "2015-02-20T14:14:47"}を指定した場合、Brazeはユーザーのローカル時間ではなく、UTCで指定した時間にメッセージを送信します。
• 送信予定時刻に近い、または送信予定時刻中に更新されたスケジュール済みトリガーはベストエフォートで更新されるため、Brazeはターゲットユーザーの全員、一部、またはいずれにも直前の変更を適用する可能性があります。

前提条件

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

レート制限

APIレート制限に記載されているように、このエンドポイントにはデフォルトのBrazeレート制限（1時間あたり250,000リクエスト）が適用されます。

リクエスト本文

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