카탈로그 만들기

post

/catalogs

이 엔드포인트를 사용하여 카탈로그를 만듭니다.

See me in Postman

필수 구성 요소

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

사용량 제한

요청 매개변수

매개변수 필수 데이터 유형 설명

catalogs 필수 배열 카탈로그 객체가 포함된 배열입니다. 이 요청에는 하나의 카탈로그 개체만 허용됩니다.

카탈로그 개체 매개변수

매개변수 필수 데이터 유형 설명

name 필수 문자열 생성하려는 카탈로그의 이름입니다.

description 필수 문자열 생성하려는 카탈로그에 대한 설명입니다.

fields 필수 배열 객체에 키 name 및 type 가 포함된 객체 배열입니다.

요청 예시

curl --location --request POST 'https://rest.iad-03.braze.com/catalogs' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "catalogs": [
    {
      "name": "restaurants",
      "description": "My Restaurants",
      "fields": [
        {
          "name": "id",
          "type": "string"
        },
        {
          "name": "Name",
          "type": "string"
        },
        {
          "name": "City",
          "type": "string"
        },
        {
          "name": "Cuisine",
          "type": "string"
        },
        {
          "name": "Rating",
          "type": "number"
        },
        {
          "name": "Loyalty_Program",
          "type": "boolean"
        },
        {
          "name": "Location",
          "type": "object"
        },
        {
          "name": "Top_Dishes",
          "type": "array"
        },
        {
          "name": "Created_At",
          "type": "time"
        }
      ]
    }
  ]
}'

응답

이 엔드포인트에 대한 상태 코드 응답은 201 와 400 두 가지입니다.

성공 응답의 예

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

{
  "catalogs": [
    {
      "description": "My Restaurants",
      "fields": [
        {
          "name": "id",
          "type": "string"
        },
        {
          "name": "Name",
          "type": "string"
        },
        {
          "name": "City",
          "type": "string"
        },
        {
          "name": "Cuisine",
          "type": "string"
        },
        {
          "name": "Rating",
          "type": "number"
        },
        {
          "name": "Loyalty_Program",
          "type": "boolean"
        },
        {
          "name": "Location",
          "type": "object"
        },
        {
          "name": "Top_Dishes",
          "type": "array"
        },
        {
          "name": "Created_At",
          "type": "time"
        }
      ],
      "name": "restaurants",
      "num_items": 0,
      "updated_at": "2022-11-02T20:04:06.879+00:00"
    }
  ],
  "message": "success"
}

오류 응답의 예

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

{
  "errors": [
    {
      "id": "catalog-name-already-exists",
      "message": "A catalog with that name already exists",
      "parameters": [
        "name"
      ],
      "parameter_values": [
        "restaurants"
      ]
    }
  ],
  "message": "Invalid Request"
}