Skip to content

Edit catalog item

patch

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

Use this endpoint to edit an item in your catalog.

Rate Limit

This endpoint has a shared rate limit of 50 requests per minute between all synchronous catalog item endpoints.

Path parameters

Parameter Required Data Type Description
catalog_name Required String Name of the catalog.
item_id Required String The ID of the catalog item.

Request parameters

Parameter Required Data Type Description
items Required Array An array that contains item objects. The item objects should contain fields that exist in the catalog except for the id field. Only one item object is allowed per request.

Example request

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

Response

There are three status code responses for this endpoint: 200, 400, and 404.

Example success response

The status code 200 could return the following response body.

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

Example error response

The status code 400 could return the following response body. Refer to Troubleshooting for more information about errors you may encounter.

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"
}

Troubleshooting

The following table lists possible returned errors and their associated troubleshooting steps.

Error Troubleshooting
catalog-not-found Check that the catalog name is valid.
item-not-found Check that the item is in the catalog.
item-array-invalid items must be an array of objects.
request-includes-too-many-items You can only edit one catalog item per request.
id-in-body An item ID already exists in the catalog.
invalid-ids Supported characters for item ID names are letters, numbers, hyphens, and underscores.
ids-too-large Character limit for each item ID is 250 characters.
items-too-large Character limit for each item is 5,000 characters.
invalid-fields Confirm that the fields in the request exist in the catalog.
unable-to-coerce-value Item types can’t be converted.
filtered-set-field-too-long The field value is being used in a filtered set that exceeds the character limit for an item.
arbitrary-error An arbitrary error occurred. Please try again or contact Support.
WAS THIS PAGE HELPFUL?
New Stuff!