사용자 관계 대체

이 엔드포인트를 사용하여 하나의 사용자 관계를 생성하거나 대체합니다.

중요

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

전제 조건

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

사용량 제한

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

경로 매개변수

다음 표에는 /custom_objects/objects/{type_name}/{external_id}/users 엔드포인트의 경로 매개변수가 나열되어 있습니다.

요청 매개변수

다음 표에는 /custom_objects/objects/{type_name}/{external_id}/users 엔드포인트의 JSON 요청 본문 매개변수가 나열되어 있습니다.

요청 예시

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

샘플 요청 페이로드

1
2
3
4
5
6
7
{
  "braze_id": "507f1f77bcf86cd799439011",
  "rel_kind": "account_user",
  "attributes": {
    "role": "admin"
  }
}

샘플 cURL 요청

이 예시에서는 사용자와 acct-123 간의 account_user 관계에 대한 속성을 대체하며, 이전에 저장된 모든 속성을 덮어씁니다.

1
2
3
4
5
6
7
8
9
10
curl --location --request PUT '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",
  "attributes": {
    "role": "admin"
  }
}'

응답

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

성공 응답 예시

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

1
2
3
4
5
6
7
8
9
{
  "user_relationship": {
    "type_name": "account",
    "external_id": "acct-123",
    "rel_kind": "account_user",
    "user": { "braze_id": "507f1f77bcf86cd799439011" },
    "attributes": { "role": "admin" }
  }
}

응답 매개변수

다음 표에는 성공 응답의 필드가 나열되어 있습니다.

오류

다음 표에는 이 엔드포인트에서 발생할 수 있는 일반적인 오류와 해결 방법이 나열되어 있습니다.