카탈로그 항목 편집

patch

/catalogs/{catalog_name}/items/{item_id}

이 엔드포인트를 사용하여 카탈로그의 기존 항목을 편집할 수 있습니다.

See me in Postman

필수 구성 요소

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

사용량 제한

경로 매개변수

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

catalog_name 필수 문자열 카탈로그의 이름입니다.

item_id 필수 문자열 카탈로그 항목의 ID입니다.

요청 매개변수

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

items 필수 배열 항목 객체가 포함된 배열입니다. 항목 객체에는 id 필드를 제외하고 카탈로그에 있는 필드가 포함되어야 합니다. 요청당 하나의 항목 객체만 허용됩니다.

요청 예시

curl --location --request PATCH 'https://rest.iad-03.braze.com/catalogs/restaurants/items/restaurant1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "items": [
    {
      "Name": "Restaurant",
      "Loyalty_Program": false,
      "Location": {
        "Latitude": 33.6112,
        "Longitude": -117.8711
      },
      "Top_Dishes": {
        "$add": [
          "Biscuits",
          "Coleslaw"
        ],
        "$remove": [
          "French Fries"
        ]
      },
      "Open_Time": "2021-09-03T09:03:19.967+00:00"
    }
  ]
}'

note:

$add 및 $remove 연산자는 배열 유형 필드에만 적용 가능하며 PATCH 엔드포인트에서만 지원됩니다.

응답

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

성공 응답의 예

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

{
  "message": "success"
}

오류 응답의 예

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

{
  "errors": [
    {
      "id": "invalid-fields",
      "message": "Some of the fields given do not exist in the catalog",
      "parameters": [
        "id"
      ],
      "parameter_values": [
        "restaurant1"
      ]
    }
  ],
  "message": "Invalid Request"
}