카탈로그 항목 업데이트

put

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

이 엔드포인트를 사용하여 카탈로그의 항목을 업데이트하세요.

item_id를 찾을 수 없는 경우 이 엔드포인트는 카탈로그에 항목을 만듭니다. 이 엔드포인트는 동기식입니다.

See me in Postman

필수 구성 요소

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

사용량 제한

경로 매개변수

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

요청 매개변수

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

요청 예시

curl --location --request PUT '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": [
        "Hamburger",
        "Deluxe Cheeseburger"
      ],
      "Open_Time": "2021-09-03T09:03:19.967+00:00"
    }
  ]
}'

응답

이 엔드포인트에 대한 상태 코드 응답은 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"
}

문제 해결

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

오류	문제 해결
`arbitrary-error`	임의의 오류가 발생했습니다. 다시 시도하거나 지원팀에 문의하세요.
`catalog-not-found`	카탈로그 이름이 유효한지 확인합니다.
`filtered-set-field-too-long`	필드 값이 항목의 글자 수 제한을 초과하는 필터링된 집합에서 사용되고 있습니다.
`id-in-body`	요청 본문에서 항목 ID를 제거합니다.
`ids-too-large`	각 항목 ID의 글자 수 제한은 250자입니다.
`invalid-ids`	항목 ID 이름에 지원되는 문자는 문자, 숫자, 하이픈, 밑줄입니다.
`invalid-fields`	API 요청에서 전송하려는 모든 필드가 카탈로그에 이미 존재하는지 확인합니다. 이는 오류에 언급된 ID 필드와는 관련이 없습니다.
`invalid-keys-in-value-object`	항목 객체 키에는 `.` 또는 `$` 을 포함할 수 없습니다.
`item-already-exists`	항목이 카탈로그에 이미 존재합니다.
`item-array-invalid`	`items` 는 객체의 배열이어야 합니다.
`items-too-large`	각 항목의 글자 수 제한은 5,000자입니다.
`request-includes-too-many-items`	요청당 하나의 카탈로그 항목만 만들 수 있습니다.
`too-deep-nesting-in-value-object`	아이템 객체는 50개 이상의 중첩 레벨을 가질 수 없습니다.
`unable-to-coerce-value`	아이템 유형은 변환할 수 없습니다.

GitHub 에서 이 페이지를 편집합니다.

이 페이지가 얼마나 도움이 되었나요?

GitHub 에서 이 페이지를 편집합니다.

New Stuff!