Eliminar un elemento del catálogo
delete
/catalogs/{catalog_name}/items/{item_id}
Utiliza este punto final para eliminar un elemento de tu catálogo.
Requisitos previos
Para utilizar este punto final, necesitarás una clave de API con el permiso catalogs.delete_item
.
Límite de velocidad
Parámetros de la ruta
Parámetro | Obligatoria | Tipo de datos | Descripción |
---|---|---|---|
catalog_name |
Obligatoria | Cadena | Nombre del catálogo. |
item_id |
Obligatoria | Cadena | El ID del elemento del catálogo. |
Parámetros de la solicitud
No hay cuerpo de petición para este punto final.
Ejemplo de solicitud
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'
Respuesta
Existen tres respuestas de código de estado para este punto final: 202
, 400
y 404
.
Ejemplo de respuesta positiva
El código de estado 202
podría devolver el siguiente cuerpo de respuesta.
1
2
3
{
"message": "success"
}
Ejemplo de respuesta de error
El código de estado 400
podría devolver el siguiente cuerpo de respuesta. Consulte la sección Solución de problemas para obtener más información sobre los errores que puede encontrar.
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"
}
Solución de problemas
La siguiente tabla enumera los posibles errores devueltos y los pasos asociados para solucionarlos.
Error | Solución de problemas |
---|---|
arbitrary-error |
Se ha producido un error arbitrario. Vuelva a intentarlo o póngase en contacto con el servicio de asistencia. |
catalog-not-found |
Compruebe que el nombre del catálogo es válido. |
item-not-found |
Comprueba que el elemento a eliminar existe en tu catálogo. |
New Stuff!