Skip to content

Crear campos de catálogo

post

/catalogs/{catalog_name}/fields

Utiliza este punto de conexión para crear varios campos en tu catálogo.

Requisitos previos

Para utilizar este punto de conexión, necesitarás una clave de API con el permiso catalogs.create_fields.

Límite de velocidad

Este punto de conexión tiene un límite de velocidad compartido de 50 solicitudes por minuto entre todos los puntos finales asíncronos de campos y selecciones de catálogo, como se documenta en Límites de velocidad de la API.

Parámetros de ruta

Parámetro Obligatorio Tipo de datos Descripción
catalog_name Obligatorio Cadena Nombre del catálogo.

Parámetros de la solicitud

Parámetro Obligatorio Tipo de datos Descripción
fields Obligatorio Matriz Una matriz que contiene objetos de campo. Los objetos de campo 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
24
25
26
27
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"
    },
    {
      "name": "Location",
      "type": "geo"
    }
  ]
}'

Respuesta

Existen tres respuestas de código de estado para este punto de conexión: 202, 400 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 400 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
arbitrary-error Se ha producido un error arbitrario. Inténtalo de nuevo o ponte en contacto con Soporte.
catalog-not-found Comprueba 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!