Ir al contenido

Esta página fue traducida automáticamente y puede contener errores. Para informar de un error de traducción, usa el componente de comentarios situado bajo el sumario, a la derecha de la página.

Crear objeto de datos

post

/data_objects/objects/{type_name}

Utiliza este endpoint para crear un objeto de datos para un tipo.

Importante

Los objetos de datos se encuentran actualmente en acceso anticipado. Tu espacio de trabajo debe estar habilitado antes de que los permisos de clave de API de objetos de datos aparezcan en Configuración > Claves de API.

Requisitos previos

Para utilizar este endpoint, necesitas una clave de API con el permiso data_objects.create.

Límite de velocidad

Este endpoint se encuentra en el contenedor de escritura de objetos de datos con un límite predeterminado de 50 solicitudes por minuto.

Parámetros de ruta

La siguiente tabla enumera y describe los parámetros de ruta para el endpoint /data_objects/objects/{type_name}.

Parámetro	Obligatorio	Tipo de datos	Descripción
`type_name`	Obligatorio	Cadena	Nombre de máquina del tipo de objeto de datos

Parámetros de solicitud

La siguiente tabla enumera y describe los parámetros del cuerpo de la solicitud JSON para el endpoint /data_objects/objects/{type_name}.

Parámetro	Obligatorio	Tipo de datos	Descripción
`external_id`	Obligatorio	Cadena	Identificador del objeto, único dentro del tipo
`attributes`	Obligatorio	Objeto	Valores con clave de nombre de campo validados contra el esquema del tipo
`display_name`	Opcional	Cadena	Etiqueta de visualización del objeto. Cuando el tipo tiene un campo de origen de nombre de visualización, el valor de ese campo tiene prioridad. Se establece de forma predeterminada en `external_id`

Ejemplo de solicitud

Esta sección incluye una carga útil JSON de ejemplo y una solicitud cURL de ejemplo.

Carga útil de solicitud de ejemplo

{
  "external_id": "acct-new",
  "attributes": {
    "name": "New Account",
    "industry": "software"
  }
}

Solicitud cURL de ejemplo

Este ejemplo crea un registro account con el identificador acct-new y establece sus atributos name e industry.

curl --location --request POST 'https://rest.iad-01.braze.com/data_objects/objects/account' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "external_id": "acct-new",
  "attributes": {
    "name": "New Account",
    "industry": "software"
  }
}'

Respuesta

Esta sección incluye un ejemplo de respuesta exitosa y los campos de la respuesta.

Ejemplo de respuesta exitosa

El código de estado 201 podría devolver el siguiente cuerpo de respuesta.

{
  "data_object": {
    "type_name": "account",
    "external_id": "acct-new",
    "attributes": { "name": "New Account", "industry": "software" }
  }
}

Parámetros de respuesta

La siguiente tabla enumera y describe los campos en una respuesta exitosa.

Parámetro	Obligatorio	Tipo de datos	Descripción
`data_object`	Obligatorio	Objeto	Registro del objeto de datos creado
`data_object.type_name`	Obligatorio	Cadena	Nombre de máquina del tipo de objeto de datos
`data_object.external_id`	Obligatorio	Cadena	Identificador del objeto de datos
`data_object.attributes`	Obligatorio	Objeto	Atributos almacenados del objeto con clave de nombre de campo

Errores

La siguiente tabla enumera los errores comunes para este endpoint y cómo resolverlos.

Estado	Causa	Orientación
`400`	Campo de atributo desconocido o tipo de atributo no válido	Confirma que cada campo en `attributes` existe en el esquema del tipo y utiliza el tipo de datos correcto.
`404`	Tipo no encontrado (`data-object-type-not-found`)	Confirma que `type_name` existe en el espacio de trabajo y coincide exactamente con el nombre de máquina.
`409`	Objeto duplicado (`duplicate-data-object`)	Utiliza un `external_id` diferente, o utiliza `PUT` para reemplazar el objeto existente.
`422`	Límite de registros alcanzado (`data-object-record-limit-exceeded`)	Reduce el número de objetos para el tipo, o contacta con soporte de Braze sobre los límites de tu espacio de trabajo.
`401`	Clave de API REST faltante o no válida	Verifica que el encabezado `Authorization` utilice `Bearer YOUR_REST_API_KEY` y que la clave esté activa.
`403`	La clave de API no tiene permisos o la solicitud está bloqueada por la lista de permitidos	Confirma que la clave tiene el permiso `data_objects.create` y que tu IP de origen está en la lista de permitidos de la clave, si está configurada.
`429`	Límite de velocidad excedido	Reintenta después de `X-RateLimit-Reset` y reduce la frecuencia de solicitudes.

New Stuff!