Skip to content

카탈로그 필드 생성

post

/catalogs/{catalog_name}/fields

이 엔드포인트를 사용하여 카탈로그에 여러 필드를 생성합니다.

필수 조건

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

사용량 제한

이 엔드포인트는 API 사용량 제한 설명서에 명시된 바와 같이, 모든 비동기 카탈로그 필드 및 선택 엔드포인트 간에 분당 50건의 요청이라는 공유 사용량 제한이 적용됩니다.

경로 매개변수

매개변수 필수 데이터 유형 설명
catalog_name 필수 문자열 카탈로그의 이름입니다.

요청 매개변수

매개변수 필수 데이터 유형 설명
fields 필수 배열 필드 오브젝트를 포함하는 배열입니다. 필드 오브젝트에는 새 필드의 이름과 유형이 포함되어야 합니다.

요청 예시

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

curl --location --request POST 'https://rest.iad-03.braze.com/catalogs/restaurants/fields' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "fields": [
    {
      "name": "Name",
      "type": "string"
    },
    {
      "name": "Ratings",
      "type": "number"
    },
    {
      "name": "Loyalty_Program",
      "type": "boolean"
    },
    {
      "name": "Created_At",
      "type": "time"
    }
  ]
}'

응답

이 엔드포인트에 대한 상태 코드 응답은 202, 400, 404의 세 가지가 있습니다.

성공 응답 예시

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

1
2
3

{
  "message": "success"
}

오류 응답 예시

400 상태 코드는 다음과 같은 응답 본문을 반환할 수 있습니다. 발생할 수 있는 오류에 대한 자세한 내용은 문제 해결을 참조하세요.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

{
  "errors": [
    {
      "id": "catalog-not-found",
      "message": "Could not find catalog",
      "parameters": [
        "catalog_name"
      ],
      "parameter_values": [
        "restaurants"
      ]
    }
  ],
  "message": "Invalid Request"
}

문제 해결

다음 표에는 반환될 수 있는 오류와 관련 문제 해결 단계가 나와 있습니다.

오류 문제 해결
arbitrary-error 임의의 오류가 발생했습니다. 다시 시도하거나 고객지원팀에 문의하세요.
catalog-not-found 카탈로그 이름이 유효한지 확인하세요.
company-size-limit-already-reached 카탈로그 저장소 크기 제한에 도달했습니다.
request-includes-too-many-fields 각 요청은 최대 50개의 새 필드를 지원할 수 있습니다.
catalog-exceeds-fields-limit 카탈로그에는 500개를 초과하는 필드를 포함할 수 없습니다.
New Stuff!