커스텀 오브젝트 교체

이 엔드포인트를 사용하여 전체 속성 교체 방식으로 커스텀 오브젝트를 생성하거나 교체합니다.

중요

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

전제 조건

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

사용량 제한

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

경로 매개변수

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

요청 매개변수

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

요청 예시

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

샘플 요청 페이로드

1
2
3
4
5
{
  "attributes": {
    "name": "Updated Account"
  }
}

샘플 cURL 요청

이 예시에서는 acct-123에 저장된 속성을 페이로드의 속성으로 교체합니다. 해당 식별자를 가진 레코드가 없는 경우 이 요청은 새로 생성합니다.

1
2
3
4
5
6
7
8
curl --location --request PUT 'https://rest.iad-01.braze.com/custom_objects/objects/account/acct-123' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "attributes": {
    "name": "Updated Account"
  }
}'

응답

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

성공 응답 예시

상태 코드 200은 다음과 같은 응답 본문을 반환할 수 있습니다. 이 엔드포인트는 요청이 오브젝트를 생성했는지 교체했는지에 관계없이 200을 반환합니다.

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

응답 매개변수

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

오류

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