スケジュールされたAPIトリガーCanvasesを削除

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

スケジュールされたメッセージやトリガーが、送信予定時刻の間近またはその最中に削除された場合、ベストエフォートで更新されます。そのため、Brazeは対象ユーザーの全員、一部、またはゼロ人に対して直前の削除を適用する可能性があります。

前提条件

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

レート制限

APIレート制限に記載されているように、このエンドポイントにはデフォルトのBrazeレート制限（1時間あたり250,000リクエスト）が適用されます。

リクエスト本文

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

1
2
3
4
{
  "canvas_id": (required, string) the Canvas 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/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"
}'