Skip to content

外部IDを削除する

post

/users/external_ids/remove

このエンドポイントを使用して、ユーザーの古い非推奨の外部IDを削除します。

1回のリクエストで送信できる外部IDは最大50個です。

See me in Postman

前提条件

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

レート制限

APIレート制限に記載されているように、このエンドポイントには1分あたり1,000リクエストのレート制限が適用されます。

リクエスト本文

1
2

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

1
2
3

{
  "external_ids" : (required, array of external identifiers to remove)
}

リクエストパラメーター

パラメーター 必須 データタイプ 説明
external_ids 必須 文字列の配列 削除するユーザーの外部識別子。

リクエスト例

1
2
3
4
5
6
7
8
9

curl --location --request POST 'https://rest.iad-01.braze.com/users/external_ids/remove' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "external_ids" :[
    "existing_deprecated_external_id_string",
    ...
  ]
}'

応答

応答では、成功したすべての削除と、関連するエラーを伴う失敗した削除が確認されます。removal_errors フィールドのエラーメッセージは、元のリクエストの配列内のインデックスを参照します。

1
2
3
4
5

{
  "message" : (string) status message,
  "removed_ids" : (array of strings) successful remove operations,
  "removal_errors": (array of arrays) <minor error message>
}

message フィールドは、有効なリクエストに対して success を返します。より具体的なエラーは removal_errors 配列に格納されます。message フィールドは、以下の場合にエラーを返します：

  • 無効なAPIキー
  • 空の external_ids 配列
  • 50を超える項目を持つ external_ids 配列
  • レート制限超過（1,000リクエスト/分超）
New Stuff!