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

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

送信予定時刻に非常に近いか、送信予定時刻に削除されたスケジュール済みのメッセージまたはトリガーは、ベストエフォートで更新されます。このため、直前の削除は、ターゲットユーザーの全員または一部に適用されるか、あるいはまったく適用されない可能性があります。

前提条件

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

レート制限

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

Request body

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