--- openapi: 3.0.3 info: title: Braze REST API – Delete a catalog item description: | ## Prerequisites To use this endpoint, you'll need an [API key]({{site.baseurl}}/api/basics#rest-api-key-permissions) with the `catalogs.delete_item` permission. ## Rate limit This endpoint has a shared rate limit of 50 requests per minute between all synchronous catalog item endpoints, as documented in [API rate limits]({{site.baseurl}}/api/api_limits/). version: 1.0.0 contact: name: Braze Support url: https://www.braze.com/docs/braze_support/ license: name: Braze Documentation url: https://www.braze.com/docs/api/home/ servers: - url: https://rest.iad-01.braze.com description: US-01 - url: https://rest.iad-02.braze.com description: US-02 - url: https://rest.iad-03.braze.com description: US-03 - url: https://rest.iad-04.braze.com description: US-04 - url: https://rest.iad-05.braze.com description: US-05 - url: https://rest.iad-06.braze.com description: US-06 - url: https://rest.iad-07.braze.com description: US-07 - url: https://rest.iad-08.braze.com description: US-08 - url: https://rest.us-10.braze.com description: US-10 - url: https://rest.fra-01.braze.eu description: EU-01 - url: https://rest.fra-02.braze.eu description: EU-02 - url: https://rest.au-01.braze.com description: AU-01 - url: https://rest.id-01.braze.com description: ID-01 - url: https://rest.jp-01.braze.com description: JP-01 - url: https://rest.kr-01.braze.com description: KR-01 security: - BearerAuth: [] paths: "/catalogs/{catalog_name}/items/{item_id}": delete: summary: Delete a catalog item operationId: delete_catalogs_catalog_name_items_item_id_delete_catalog_item parameters: - name: catalog_name in: path required: true description: Name of the catalog. schema: type: string example: restaurants - name: item_id in: path required: true description: The ID of the catalog item. schema: type: string example: restaurant1 responses: "200": description: | The request succeeded and the catalog item was deleted. No action needed. The status code `200` could return the following response body. content: application/json: schema: $ref: '#/components/schemas/CatalogItemResponse' examples: success: summary: Catalog item deleted value: message: success "401": description: | Unauthorized. The REST API key is missing, malformed, or sent to the wrong REST endpoint. Send the key as `Authorization: Bearer YOUR_REST_API_KEY` to the correct [REST endpoint]({{site.baseurl}}/api/basics/#endpoints). For more causes, see [Errors and responses]({{site.baseurl}}/api/errors/#fatal-errors). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: invalid_api_key: summary: Invalid API key value: message: 'Invalid API key: YOUR_REST_API_KEY' "403": description: Access denied. The REST API key doesn't have the required permission. Use a REST API key that has the `catalogs.delete_item` permission. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: access_denied: summary: Missing permission value: message: Access Denied "404": description: | Not found. To resolve it: - **No item matches the `id` (`item-not-found`):** Pass a valid item `id`, or create the item first. Check that the item to be deleted exists in your catalog. - **No catalog matches the `catalog_name` (`catalog-not-found`):** Pass a valid `catalog_name`. Find it with the [List catalogs endpoint]({{site.baseurl}}/api/endpoints/catalogs/catalog_management/synchronous/get_list_catalogs/). Check that the catalog name is valid. The status code `404` could return the following response body. Refer to [Troubleshooting](#troubleshooting) for more information about errors you may encounter. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: item_not_found: summary: Could not find item value: errors: - id: item-not-found message: Could not find item parameters: - item_id parameter_values: - restaurant34 message: Invalid Request catalog_not_found: summary: Could not find catalog value: errors: - id: catalog-not-found message: Could not find catalog parameters: - catalog_name parameter_values: - restaurants_old message: Not Found "429": description: | Rate limited. You exceeded the rate limit for this endpoint. Slow your request rate and retry with exponential backoff. See [API rate limits]({{site.baseurl}}/api/api_limits/). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: over_rate_limit: summary: Over rate limit value: message: You have exceeded your limit of 50 requests per minute. Please contact your account executive to increase your limit. If you do not have their info, you may contact Braze directly at https://www.braze.com/contact/. 5XX: description: | Internal server error. An unexpected error occurred on the Braze server. Retry with exponential backoff. If the error persists, contact [Support]({{site.baseurl}}/braze_support/). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' components: securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: REST API key description: | REST API keys are created in the Braze dashboard at **Settings → APIs and Identifiers → API Keys**. The key must include the `catalogs.delete_item` permission. Pass the key as `Authorization: Bearer YOUR_REST_API_KEY`. schemas: CatalogItemResponse: title: Delete catalog item response type: object properties: message: type: string example: success CatalogError: title: Catalog error type: object properties: id: type: string description: The error ID. See [Troubleshooting](#troubleshooting). example: item-not-found message: type: string description: Human-readable error message. example: Could not find item parameters: type: array description: The request parameters that caused the error. items: type: string parameter_values: type: array description: The values of those parameters. items: type: string ErrorResponse: title: Error type: object properties: errors: type: array items: $ref: '#/components/schemas/CatalogError' message: type: string description: Human-readable error message.