Skip to content

外部IDを削除する

post

/users/external_ids/remove

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

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

See me in Postman

前提条件

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

レート制限

要求本文:

1
2

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

1
2
3

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

リクエストパラメーター

リクエスト例

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 リクエスト/分超)
Github   GitHub でこのページを編集
「このページはどの程度役に立ちましたか?」
New Stuff!