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

post

/canvas/trigger/schedule/delete

core endpoint

「スケジュールを削除」エンドポイントを使用すると、以前に API トリガーキャンバスをスケジュールしたメッセージを、送信前にキャンセルできます。

スケジュールされたメッセージやトリガーが送信予定時刻の直前または送信中に削除された場合、最善の努力で更新されるため、最後の瞬間の削除は、ターゲットユーザー全員、一部、または誰にも適用されない可能性があります。

See me in Postman

前提条件

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

レート制限

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

要求本文:

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY

{
  "canvas_id": (required, string) the Canvas identifier,
  "schedule_id": (required, string) the `schedule_id` to delete (obtained from the response to create schedule)
}

リクエストパラメーター

パラメータ	必須	データ型	説明
`canvas_id`	必須	文字列	キャンバス識別子を参照してください。
`schedule_id`	必須	文字列	削除する`schedule_id`（スケジュールの作成に対する応答から取得）。

例のリクエスト

curl --location --request POST 'https://rest.iad-01.braze.com/canvas/trigger/schedule/delete' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "canvas_id": "canvas_identifier",
  "schedule_id": "schedule_identifier"
}'

GitHub でこのページを編集

「このページはどの程度役に立ちましたか?」

GitHub でこのページを編集

New Stuff!