ユーザーを削除する

APIMETHOD POST CORE_ENDPOINT| <div class='api_type'><div class='method post '>post</div>

/users/delete

</div>

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

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

前提条件

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

レート制限

要求本文:

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
}

リクエストパラメーター

メールでユーザーを削除する

識別子としてemail が指定された場合、識別子にはさらにprioritization の値が必要となる。prioritization は順序付き配列で、複数のユーザーが見つかった場合、どのユーザーを削除するかを指定する。つまり、複数のユーザーが優先順位に一致する場合、ユーザーの削除は起こらない。

配列に使用できる値は、identified、unidentified、most_recently_updated です。most_recently_updated は、最も最近更新されたユーザーを優先することを意味します。

優先配列には、一度に以下のオプションのうち1つしか存在できません。

• identified を持つユーザーを優先することである。 external_id
• unidentified のないユーザーを優先することである。 external_id

例のリクエスト

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
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"
    }
  ],
  "email_addresses": [
    {
      "email": "[email protected]",
      "prioritization": ["unidentified", "most_recently_updated"]
    }
  ]
}'

応答

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
}