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

このエンドポイントを使用して、ダッシュボードで作成したスケジュール済みの API トリガーキャンペーンを更新し、メッセージの送信をトリガーするアクションを決定できます。

Brazeがメッセージ自体にテンプレート化するtrigger_propertiesを渡すことができます。

このエンドポイントでメッセージを送信するには、API トリガーキャンペーンを作成する際に生成されるキャンペーン ID が必要です。

スケジュールは、スケジュール作成リクエストまたは以前のスケジュール更新リクエストで指定したものを完全に上書きします。たとえば、最初にスケジュールを"schedule" : {"time" : "2015-02-20T13:14:47", "in_local_time" : true}に設定し、後で"schedule" : {"time" : "2015-02-20T14:14:47"}に更新した場合、Brazeはユーザーのローカル時間ではなく、UTC で指定された時間にメッセージを送信します。

スケジュールされたトリガーが送信予定時刻の直前または送信中に更新された場合、ベストエフォートで更新されます。そのため、Brazeはターゲットユーザーの全員、一部、またはいずれにも直前の変更を適用できる場合があります。元のスケジュールがローカル時間を使用しており、元の時刻がいずれかのタイムゾーンで既に経過している場合、更新は適用されません。

前提条件

このエンドポイントを使用するには、campaigns.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
{
  "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
  }
}

リクエストパラメーター

リクエスト例

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