Skip to content

Delete a catalog item

delete

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

Use this endpoint to delete 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.

Request parameters

There is no request body for this endpoint.

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.

Example request

1
2
3
curl --location --request DELETE 'https://rest.iad-03.braze.com/catalogs/restaurants/items/restaurant1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Response

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

Example success response

The status code 202 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": "item-not-found",
      "message": "Could not find item",
      "parameters": [
        "item_id"
      ],
      "parameter_values": [
        "restaurant34"
      ]
    }
  ],
  "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 to be deleted exists in your catalog.
arbitrary-error An arbitrary error occurred. Please try again or contact Support.
WAS THIS PAGE HELPFUL?
New Stuff!