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

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

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

このエンドポイントでメッセージを送信するには、API-Triggered キャンペーン をビルドするときに作成されるキャンペーン ID が必要です。

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

送信される予定の、または送信される予定の時間に非常に近い、更新されたスケジュールされたトリガーは、最後の2 番目の変更がターゲットユーザーのすべて、一部、またはすべてに適用されるように、最善の努力で更新されます。元のスケジュールがローカル時刻を使用しており、元の時刻がいずれかのタイムゾーンで既に経過している場合、更新は適用されません。

前提条件

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

レート制限

API レート制限で説明されているように、このエンドポイントにはデフォルトの1時間あたり25万リクエストのBraze レート 制限が適用されます。

要求本文:

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