사용자 관계 삭제

이 엔드포인트를 사용하여 하나의 사용자-오브젝트 관계를 제거할 수 있습니다.

중요

커스텀 오브젝트는 현재 얼리 액세스 중입니다. 커스텀 오브젝트 API 키 권한이 설정 > API 키에 표시되려면 워크스페이스가 활성화되어 있어야 합니다.

전제 조건

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

사용량 제한

이 엔드포인트는 커스텀 오브젝트 쓰기 버킷에 포함되며, 기본값으로 분당 50회 요청으로 제한됩니다.

경로 매개변수

다음 표에서는 /custom_objects/objects/{type_name}/{external_id}/users 엔드포인트의 경로 매개변수를 나열하고 설명합니다.

요청 매개변수

다음 표에서는 /custom_objects/objects/{type_name}/{external_id}/users 엔드포인트의 JSON 요청 본문 매개변수를 나열하고 설명합니다.

참고

이 DELETE 엔드포인트는 JSON 요청 본문을 필요로 합니다. HTTP 클라이언트가 DELETE 호출 시 요청 본문을 전송하는지 확인하세요.

요청 예시

이 섹션에는 샘플 JSON 페이로드와 샘플 cURL 요청이 포함되어 있습니다.

샘플 요청 페이로드

1
2
3
4
{
  "braze_id": "507f1f77bcf86cd799439011",
  "rel_kind": "account_user"
}

샘플 cURL 요청

이 예시에서는 지정된 사용자와 acct-123 간의 account_user 관계를 제거합니다. 고객 프로필과 계정 레코드는 모두 그대로 유지됩니다.

1
2
3
4
5
6
7
curl --location --request DELETE 'https://rest.iad-01.braze.com/custom_objects/objects/account/acct-123/users' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "braze_id": "507f1f77bcf86cd799439011",
  "rel_kind": "account_user"
}'

응답

이 섹션에는 성공 응답 예시와 응답 필드가 포함되어 있습니다.

성공 응답 예시

상태 코드 200은 다음과 같은 응답 본문을 반환할 수 있습니다.

1
{ "deleted": true }

응답 매개변수

다음 표에서는 성공 응답의 필드를 나열하고 설명합니다.

오류

다음 표에서는 이 엔드포인트의 일반적인 오류와 해결 방법을 나열합니다.