Skip to content

外部ID の削除

post

/users/external_ids/remove

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

リクエストごとに最大 50 個の外部 ID を送信できます。

See me in Postman

前提条件

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

レート制限

We apply a rate limit of 1,000 requests per minute to this endpoint, as documented in API rate limits.

リクエスト本文

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 配列

  • external_ids 50 項目以上の配列 - レートリミットヒット(1000件/分以上)
  Edit this page on GitHub
HOW HELPFUL WAS THIS PAGE?
New Stuff!