ユーザーを削除する

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

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

API 経由でユーザーを一括削除しても解決できないユースケースがある場合は、Braze サポートチームにお問い合わせください。

前提条件

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

レート制限

このエンドポイントには、毎分20,000リクエストの共有レート制限を適用する。このレート制限は、API レート制限に記載されているように、/users/identify、/users/merge、/users/alias/update、および /users/merge エンドポイントと共有されます。

要求本文:

1
2
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY

1
2
3
4
5
6
7
{
  "external_ids" : (optional, array of string) External IDs to be deleted,
  "user_aliases" : (optional, array of user alias objects) User aliases to be deleted,
  "braze_ids" : (optional, array of string) Braze user identifiers to be deleted,
  "email_addresses": (optional, array of string) User emails to be deleted,
  "phone_numbers": (optional, array of string) User phone numbers to be deleted
}

リクエストパラメーター

メールアドレスと電話番号によるユーザーの削除

メールアドレスまたは電話番号が識別子として指定されている場合、追加の prioritization 値が識別子に必要です。prioritization は順序付けされた配列である必要があり、複数のユーザーがいる場合に削除するユーザーを指定する必要があります。つまり、複数のユーザーが優先順位に一致する場合、ユーザーの削除は起こらない。

配列に指定できる値は次のとおりです。

• identified
• unidentified
• most_recently_updated (最近更新されたユーザーを優先することを意味します）

prioritization 配列には、一度に次のオプションのいずれかが存在する場合があります。

• 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
}