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

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

通行できます trigger_properties メッセージ自体にテンプレート化されます。

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

任意のスケジュールは、スケジュール作成リクエストまたは以前のスケジュール更新リクエストで指定したスケジュールを完全に上書きします。例えば、最初に "schedule" : {"time" : "2015-02-20T13:14:47", "in_local_time" : true} そしてアップデートでは "schedule" : {"time" : "2015-02-20T14:14:47"}、メッセージはユーザーの現地時間ではなく、UTC で指定された時間に送信されるようになります。送信されるはずの時間に非常に近い時間またはその間に更新されるスケジュールされたトリガーは、最大限の努力で更新されるため、土壇場での変更が対象ユーザーのすべて、一部、またはまったく適用されない可能性があります。

前提条件

このエンドポイント を 使用するには、 campaigns.trigger.schedule.update 許可。

レート制限

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