Crear selección de catálogo

Utiliza este endpoint para crear una selección en tu catálogo.

Requisitos previos

Para utilizar este endpoint, necesitarás una clave de API con el permiso catalogs.create_selection.

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 ruta

Parámetros de solicitud

Parámetros del objeto de selección

Nota

Los parámetros sort_field y sort_order deben utilizarse juntos. Si proporcionas uno sin el otro, u omites ambos parámetros, los resultados de la selección se devuelven en orden aleatorio.

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
curl --location --request POST 'https://rest.iad-03.braze.com/catalogs/restaurants/selections' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "selection": {
    "name": "favorite-restaurants",
    "description": "Favorite restaurants in NYC",
    "external_id": "favorite-nyc-restaurants",
    "source": "custom",
    "filters": [
      {
        "field": "City",
        "operator": "equals",
        "value": "NYC"
      },
      {
        "field": "Rating",
        "operator": "greater than",
        "value": 7
      }
    ],
    "results_limit": 10,
    "sort_field": "Rating",
    "sort_order": "desc"
  }
}'

Operadores de filtrado

Nota

La API admite un máximo de cuatro filtros por solicitud de selección. En el panel de Braze, puedes añadir hasta 10 filtros por selección. Los filtros se aplican en el orden en que aparecen en la matriz.

Nota

Cuando aplicas un filtro geo, el sistema ordena automáticamente los resultados por distancia, con el elemento más cercano primero, independientemente de los parámetros sort_field y sort_order.

Respuesta

Existen tres respuestas de código de estado para este endpoint: 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.