Borrar campo de catálogo
delete
/catalogs/{catalog_name}/fields/{field_name}
Utiliza este punto final para eliminar un campo del catálogo.
Requisitos previos
Para utilizar este punto final, necesitarás una clave de API con el permiso catalogs.delete_fields
.
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. |
field_name |
Obligatoria | Cadena | Nombre del campo del catálogo. |
Ejemplo de solicitud
1
2
3
curl --location --request DELETE 'https://rest.iad-03.braze.com/catalogs/restaurants/fields/ratings' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
Respuesta
Hay dos respuestas de código de estado para este punto final: 202
y 404
.
Ejemplo de respuesta satisfactoria
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 404
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": "catalog-not-found",
"message": "Could not find catalog",
"parameters": [
"catalog_name"
],
"parameter_values": [
"restaurants"
]
}
],
"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 |
---|---|
catalog-not-found |
Compruebe que el nombre del catálogo es válido. |
field-referenced-by-selection |
Comprueba que el campo del catálogo está siendo utilizado por una selección. |
field-is-inventory |
Comprueba que el campo de catálogo se utiliza como campo de inventario. |
invalid-field-name |
Comprueba que el nombre del campo del catálogo es válido. |
New Stuff!