Delete catalog selection
/catalogs/{catalog_name}/selections/{selection_name}
Use this endpoint to delete a catalog selection.
This endpoint is currently in early access. Contact your customer success manager if you’re interested in participating in this early access.
Prerequisites
To use this endpoint, you’ll need an API key with the catalogs.delete_selection
permission.
Rate limit
This endpoint has a shared rate limit of 50 requests per minute between all asynchronous catalog fields and selections endpoints, as documented in API rate limits.
Path parameters
Parameter | Required | Data Type | Description |
---|---|---|---|
catalog_name |
Required | String | Name of the catalog. |
selection_name |
Required | String | Name of the catalog selection. |
Example request
1
2
3
curl --location --request DELETE 'https://rest.iad-03.braze.com/catalogs/restaurants/selections/favorite_list' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
Response
There are two status code responses for this endpoint: 202
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 404
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": "catalog-not-found",
"message": "Could not find catalog",
"parameters": [
"catalog_name"
],
"parameter_values": [
"restaurants"
]
}
],
"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. |
invalid-selection |
Check that the selection name is valid. |