Eliminar campo de catálogo
/catalogs/{catalog_name}/fields/{field_name}
Utiliza este endpoint para eliminar un campo del catálogo.
Requisitos previos
Para utilizar este endpoint, necesitarás una clave de API con el permiso catalogs.delete_fields.
Límite de velocidad
Este endpoint tiene un límite de velocidad compartido de 50 solicitudes por minuto entre todos los endpoints asíncronos de campos y selecciones de catálogo, como se documenta en Límites de velocidad de la API.
Parámetros de la ruta
| Parámetro | Obligatorio | Tipo de datos | Descripción |
|---|---|---|---|
catalog_name |
Obligatorio | Cadena | Nombre del catálogo. |
field_name |
Obligatorio | 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 endpoint: 202 y 404.
Ejemplo de respuesta correcta
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. Consulta la sección Solución de problemas para obtener más información sobre los errores que puedes 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 sus pasos asociados para la solución de problemas.
| Error | Solución de problemas |
|---|---|
catalog-not-found |
Comprueba que el nombre del catálogo sea válido. |
field-referenced-by-selection |
Comprueba que el campo del catálogo no esté siendo utilizado actualmente por una selección. |
field-is-inventory |
Comprueba que el campo del catálogo se utiliza como campo de inventario. |
invalid-field-name |
Comprueba que el nombre del campo del catálogo sea válido. |