커스텀 오브젝트 가져오기

이 엔드포인트를 사용하여 하나의 커스텀 오브젝트를 반환합니다.

중요

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

전제 조건

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

사용량 제한

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

경로 매개변수

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

요청 예시

이 섹션에는 샘플 경로 매개변수 페이로드와 샘플 cURL 요청이 포함되어 있습니다.

샘플 요청 페이로드

이 요청의 경로 매개변수에 대한 참조로 이 JSON 오브젝트를 사용하세요.

1
2
3
4
{
  "type_name": "account",
  "external_id": "acct-123"
}

샘플 cURL 요청

이 예시는 acct-123 계정 레코드와 저장된 속성을 검색합니다.

1
2
curl --location --request GET 'https://rest.iad-01.braze.com/custom_objects/objects/account/acct-123' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'

응답

이 섹션에는 샘플 성공 응답과 응답 필드가 포함되어 있습니다.

성공 응답 예시

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

1
2
3
4
5
6
7
{
  "custom_object": {
    "type_name": "account",
    "external_id": "acct-123",
    "attributes": { "name": "Acme", "industry": "software" }
  }
}

응답 매개변수

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

오류

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