Skip to content

ユーザーの削除

post

/users/delete

core endpoint

このエンドポイントを使用して、既知のユーザー識別子を指定してユーザープロファイルを削除します。

1 つのリクエストには、最大 50 個の external_ids、user_aliases、または braze_ids を含めることができます。単一のリクエストに含めることができるのは、external_ids、user_aliases、またはbraze_ids のいずれか1つだけです。

See me in Postman

前提条件

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

レート制限

For customers who onboarded with Braze on or after September 16, 2021, we apply a shared rate limit of 20,000 requests per minute to this endpoint. This rate limit is shared with the /users/alias/new, /users/identify, and /users/merge endpoints, as documented in API rate limits.

リクエスト本文

1
2

Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY

1
2
3
4
5

{
  "external_ids" : (optional, array of string) External ids for the users to delete,
  "user_aliases" : (optional, array of user alias objects) User aliases for the users to delete,
  "braze_ids" : (optional, array of string) Braze user identifiers for the users to delete
}

要求パラメータ

パラメータ 必須 データ型 説明
external_ids オプション 文字列の配列 削除するユーザの外部識別子。
user_aliases オプション 削除するユーザのユーザエイリアスオブジェクトの配列 ユーザエイリアス
braze_ids オプション 文字列の配列 削除するユーザのユーザ識別子をろう付け

リクエスト例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

curl --location --request POST 'https://rest.iad-01.braze.com/users/delete' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
  "external_ids": ["external_identifier1", "external_identifier2"],
  "braze_ids": ["braze_identifier1", "braze_identifier2"],
  "user_aliases": [
    {
      "alias_name": "user_alias1", "alias_label": "alias_label1"
    },
    {
      "alias_name": "user_alias2", "alias_label": "alias_label2"
    }
  ]
}'

レスポンス

1
2
3
4
5

Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
{
  "deleted" : (required, integer) number of user ids queued for deletion
}
  GitHub でこのページを編集
「このページはどの程度役に立ちましたか?」
New Stuff!