사용자 삭제

이 엔드포인트를 사용하여 알려진 사용자 식별자를 지정하여 고객 프로필을 삭제할 수 있습니다.

하나의 요청에 최대 50개의 external_ids, user_aliases, braze_ids, email_addresses 또는 phone_numbers를 포함할 수 있습니다. external_ids, user_aliases, braze_ids, email_addresses, phone_numbers 중 하나만 하나의 요청에 포함할 수 있습니다.

API를 통한 대량 사용자 삭제로 해결할 수 없는 사용 사례가 있는 경우 Braze 고객지원팀에 문의하여 도움을 받으세요.

필수 조건

이 엔드포인트를 사용하려면 users.delete 권한이 있는 API 키가 필요합니다.

사용량 제한

이 엔드포인트에는 분당 20,000건의 요청에 대한 공유 사용량 제한이 적용됩니다. 이 사용량 제한은 API 사용량 제한 설명서에 설명된 대로 /users/alias/new, /users/identify, /users/merge 및 /users/alias/update 엔드포인트와 공유됩니다.

요청 본문

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
{
  "deleted" : (required, integer) number of user IDs queued for deletion
}

문제 해결

성공 응답이 반환되었지만 사용자가 여전히 표시됩니다

성공 응답은 요청이 대기줄에 추가되었음을 확인하는 것이지, 삭제가 완료되었음을 의미하지 않습니다. 삭제는 일반적으로 1초 이내에 완료되지만, 모든 캐시에 변경 사항이 전파되기까지 최대 5분이 걸릴 수 있습니다. 삭제 직후 대시보드에서 사용자를 검색하거나 API를 통해 데이터를 내보내면 이 전파 기간 동안 여전히 결과가 표시될 수 있습니다.

몇 분이 지난 후에도 사용자가 여전히 존재하는 경우, 요청의 식별자가 사용자의 실제 프로필과 일치하는지 확인하세요:

• external_ids 배열: 각 값이 사용자의 외부 ID와 정확히 일치하는지 확인하세요.
• braze_id: /users/export/ids 엔드포인트를 사용하여 사용자 데이터를 내보내거나 세그먼트를 CSV로 내보내면(braze_id가 “Appboy ID”로 표시됨) 사용자의 braze_id를 확인할 수 있습니다.
• 별칭 전용 또는 이메일 전용 프로필: 프로필에 external_id가 없는 경우, 외부 사용자 ID가 비어 있음 필터와 알려진 이메일 또는 전화번호를 결합하여 세그먼트를 생성한 다음 CSV로 내보내 braze_id를 확인하세요.

사용자가 삭제되었는지 확인하려면 삭제 요청에서 사용한 것과 동일한 식별자 유형을 사용하여 /users/export/ids 엔드포인트를 호출하세요(예: external_ids, braze_id 또는 user_aliases에 값을 포함). 사용자가 더 이상 존재하지 않으면 응답에 "users": []가 포함되며, 해당 식별자를 나열하는 "invalid_user_ids"가 포함될 수 있습니다.