カタログ項目を編集

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

前提条件

このエンドポイントを使用するには、catalogs.update_item パーミッションを持つAPI キーが必要です。

レート制限

This endpoint has a shared rate limit of 50 requests per minute between all synchronous catalog item endpoints, as documented in API rate limits.

経路パラメータ

リクエストパラメータ

リクエスト例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
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
      },
      "Open_Time": "2021-09-03T09:03:19.967+00:00"
    }
  ]
}'

応答

このエンドポイントには、200 、400 、404 の3つのステータスコード・レスポンスがある。

成功応答例

ステータスコード200 、以下のレスポンスボディを返すことができる。

1
2
3
{
  "message": "success"
}

エラー応答例

ステータスコード400 、以下のレスポンスボディを返すことができる。遭遇する可能性のあるエラーの詳細については、「トラブルシューティング」を参照してください。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "errors": [
    {
      "id": "invalid-fields",
      "message": "Some of the fields given do not exist in the catalog",
      "parameters": [
        "id"
      ],
      "parameter_values": [
        "restaurant1"
      ]
    }
  ],
  "message": "Invalid Request"
}

トラブルシューティング

次の表は、返される可能性のあるエラーと、それに関連するトラブルシューティングの手順を示したものです。