Skip to content

セグメントによるエクスポートのキャンセル

post

/export/segment/cancel

このエンドポイントを使用して、指定されたセグメント IDで進行中のすべてのエクスポートをキャンセルします。

前提条件

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

レート制限

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

リクエスト本文

1
2
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
1
2
3
{
  "segment_id": (required, string) the `segment_id` to locate and cancel its ongoing exports
}

リクエストパラメーター

パラメーター 必須 データタイプ 説明
segment_id 必須 文字列 進行中のエクスポートをキャンセルするための segment_id

リクエスト例

1
2
3
4
5
6
curl --location --request POST 'https://rest.iad-01.braze.com/export/segment/cancel' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "segment_id": "segment_identifier"
}'
New Stuff!