Skip to content

외부 ID 제거

post

/users/external_ids/remove

이 엔드포인트를 사용하여 더 이상 사용되지 않는 사용자의 이전 외부 ID를 제거하세요.

요청당 최대 50개의 외부 ID를 보낼 수 있습니다.

See me in Postman

필수 구성 요소

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

사용량 제한

요청 본문

1
2

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY

1
2
3

{
  "external_ids" : (required, array of external identifiers to remove)
}

요청 매개변수

요청 예시

1
2
3
4
5
6
7
8
9

curl --location --request POST 'https://rest.iad-01.braze.com/users/external_ids/remove' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "external_ids" :[
    "existing_deprecated_external_id_string",
    ...
  ]
}'

응답

응답은 성공한 제거와 실패한 제거 모두 관련 오류와 함께 확인합니다. removal_errors 필드의 오류 메시지는 원래 요청의 배열에 있는 인덱스를 참조합니다.

1
2
3
4
5

{
  "message" : (string) status message,
  "removed_ids" : (array of strings) successful remove operations,
  "removal_errors": (array of arrays) <minor error message>
}

message 필드에 유효한 요청이 있으면 success를 반환합니다. 보다 구체적인 오류는 removal_errors 배열에 캡처됩니다. message 필드는 다음과 같은 경우 오류를 반환합니다.

  • 잘못된 API 키
  • 빈 external_ids 배열
  • external_ids 50개 이상의 항목이 있는 배열
  • 속도 제한 초과(분당 1,000건 이상의 요청)
Github   GitHub 에서 이 페이지를 편집합니다.
이 페이지가 얼마나 도움이 되었나요?
New Stuff!