カタログ項目を編集する

patch

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

このエンドポイントを使用して、カタログの既存のアイテムを編集する。

See me in Postman

前提条件

このエンドポイントを使用するには、API キーとcatalogs.update_itemの権限が必要です。

レート制限

このエンドポイントは、API レート制限で説明されているように、すべての同期カタログアイテムエンドポイント間で毎分50リクエストの共有レート制限があります。

パスパラメーター

パラメータ required データ型説明

catalog_name 必須文字列カタログ名。

item_id 必須文字列カタログ項目のID。

リクエストパラメーター

パラメーター required データ型説明

items required 配列アイテム・オブジェクトを含む配列。項目オブジェクトには、id フィールドを除き、カタログに存在するフィールドを含める必要があります。1つのリクエストにつき、1つのアイテムオブジェクトのみが許可される。

例のリクエスト

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 という 3 つのステータスコード応答があります。

成功応答の例

ステータスコード 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"
}