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.

Actualizar objeto de datos

patch

/data_objects/objects/{type_name}/{external_id}

Usa este endpoint para fusionar atributos en un objeto de datos existente.

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 usar este endpoint, necesitas una clave de API con el permiso data_objects.update.

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 del endpoint /data_objects/objects/{type_name}/{external_id}.

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

Parámetros de solicitud

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

Parámetro	Obligatorio	Tipo de datos	Descripción
`attributes`	Obligatorio	Objeto	Campos de nivel superior a fusionar
`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. Si se omite, se conserva el nombre de visualización existente

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

{
  "attributes": {
    "credits": 750
  }
}

Solicitud cURL de ejemplo

Este ejemplo actualiza el atributo credits en acct-123 y deja los demás atributos del registro sin cambios.

curl --location --request PATCH 'https://rest.iad-01.braze.com/data_objects/objects/account/acct-123' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{ "attributes": { "credits": 750 } }'

Respuesta

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

Ejemplo de respuesta exitosa

El código de estado 200 podría devolver el siguiente cuerpo de respuesta. El objeto attributes refleja el resultado de la fusión.

{
  "data_object": {
    "type_name": "account",
    "external_id": "acct-123",
    "attributes": { "name": "Acme", "credits": 750 }
  }
}

Parámetros de respuesta

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

Parámetro	Obligatorio	Tipo de datos	Descripción
`data_object`	Obligatorio	Objeto	Registro de objeto de datos actualizado
`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 del objeto después de la fusión

Errores

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

Estado	Causa	Orientación
`400`	Error de validación	Confirma que todos los campos en `attributes` existen en el esquema del tipo y usan el tipo de datos correcto.
`404`	Tipo no encontrado u objeto no encontrado	Confirma que tanto `type_name` como `external_id` existen en el espacio de trabajo.
`401`	Clave de API REST faltante o no válida	Verifica que el encabezado `Authorization` use `Bearer YOUR_REST_API_KEY` y que la clave esté activa.
`403`	La clave de API carece de permiso o la solicitud está bloqueada por la lista de permitidos	Confirma que la clave tiene el permiso `data_objects.update` 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!