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

このエンドポイントを使用して、送信前にAPI トリガーでスケジュールしたCanvas メッセージをキャンセルします。

スケジュールされたメッセージまたはトリガーが送信される予定の間に非常に近くまたは削除された場合は、最善の努力で更新されるため、最後の2 回目の削除はターゲットユーザーのすべて、一部、またはすべてに適用される可能性があります。

前提条件

このエンドポイントを使用するには、campaigns.trigger.schedule.delete 権限を持つ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
{
  "campaign_id": (required, string) the campaign identifier,
  "schedule_id": (required, string) the `schedule_id` to delete (obtained from the response to create schedule)
}

要求パラメータ

リクエスト例

1
2
3
4
5
6
7
curl --location --request POST 'https://rest.iad-01.braze.com/campaigns/trigger/schedule/delete' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "campaign_id": "campaign_identifier",
  "schedule_id": "schedule_identifier"
}'