Skip to content

사용자 삭제

post

/users/delete

core endpoint

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

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

See me in Postman

필수 구성 요소

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

사용량 제한

요청 본문

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이며 이는 가장 최근에 업데이트된 사용자에게 우선순위를 지정하는 것을 의미합니다.

우선순위 배열에는 한 번에 다음 옵션 중 하나만 존재할 수 있습니다.

  • 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": "john.smith@braze.com",
      "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
}
Github   GitHub 에서 이 페이지를 편집합니다.
이 페이지가 얼마나 도움이 되었나요?
New Stuff!