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

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

送信予定時刻のすぐ近くまたは送信中に削除されたスケジュールされたメッセージまたはトリガーは、ベストエフォートで更新されるため、直前の削除は、対象ユーザーのすべてまたは一部に適用されるか、まったく適用されない可能性があります。

前提 条件

このエンドポイントを使用するには、アクセス許可を持つ canvas.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
{
  "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"
}'