Crear campos de catálogo
post
/catalogs/{catalog_name}/fields
Utiliza este punto final para crear varios campos en tu catálogo.
Requisitos previos
Para utilizar este punto final, necesitarás una clave de API con el permiso catalogs.create_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. |
Parámetros de la solicitud
Parámetro | Obligatoria | Tipo de datos | Descripción |
---|---|---|---|
fields |
Obligatoria | Matriz | Una matriz que contiene objetos de campo. Los objetos fields deben contener el nombre y el tipo de los nuevos campos. |
Ejemplo de solicitud
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
curl --location --request POST 'https://rest.iad-03.braze.com/catalogs/restaurants/fields' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
"fields": [
{
"name": "Name",
"type": "string"
},
{
"name": "Ratings",
"type": "number"
},
{
"name": "Loyalty_Program",
"type": "boolean"
},
{
"name": "Created_At",
"type": "time"
}
]
}'
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": "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 |
---|---|
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. |
company-size-limit-already-reached |
Se ha alcanzado el límite de tamaño de almacenamiento del catálogo. |
request-includes-too-many-fields |
Cada solicitud puede admitir hasta 50 campos nuevos. |
catalog-exceeds-fields-limit |
El catálogo no puede tener más de 500 campos. |
New Stuff!