Ir al contenido

Actualizar relación de objeto

patch

/data_objects/objects/{type_name}/{object_id}/object_relationships

Utiliza este endpoint para fusionar atributos en una relación de objeto existente.

Requisitos previos

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

Límite de velocidad

Este endpoint pertenece al contenedor de escritura de objetos de datos, con un límite predeterminado de 1000 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}/{object_id}/object_relationships.

Parámetro Obligatorio Tipo de datos Descripción
type_name Obligatorio Cadena Tipo de objeto en la URL
object_id Obligatorio Cadena Identificador de objeto en la URL

Parámetros de solicitud

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

Parámetro Obligatorio Tipo de datos Descripción
rel_kind Obligatorio Cadena Tipo de relación
related_type_name Obligatorio Cadena Tipo de objeto relacionado
related_object_id Obligatorio Cadena Identificador de objeto relacionado
attributes Opcional Objeto Atributos de relación que se fusionarán

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

{
  "rel_kind": "subaccount",
  "related_type_name": "account",
  "related_object_id": "acct-456",
  "attributes": {}
}

Solicitud cURL de ejemplo

Este ejemplo fusiona atributos en la relación subaccount existente entre acct-123 y acct-456, y deja sin cambios los atributos que omitas.

curl --location --request PATCH 'https://rest.iad-01.braze.com/data_objects/objects/account/acct-123/object_relationships' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "rel_kind": "subaccount",
  "related_type_name": "account",
  "related_object_id": "acct-456",
  "attributes": {}
}'

Respuesta

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

Ejemplo de respuesta correcta

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

{
  "object_relationship": {
    "rel_kind": "subaccount",
    "to_data_object": {
      "type_name": "account",
      "object_id": "acct-456",
      "attributes": { "name": "Child Account" }
    },
    "attributes": {}
  }
}

Parámetros de respuesta

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

Parámetro Obligatorio Tipo de datos Descripción
object_relationship Obligatorio Objeto Registro de relación actualizado
object_relationship.rel_kind Obligatorio Cadena Valor del tipo de relación
object_relationship.to_data_object Opcional Objeto Objeto relacionado
object_relationship.from_data_object Opcional Objeto Objeto relacionado
object_relationship.attributes Obligatorio Objeto Atributos de relación 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 rel_kind y attributes son válidos para el tipo de relación.
404 Relación no encontrada (data-object-relationship-not-found) Confirma que existen el objeto de origen, el objeto relacionado y los valores de clave de relación.
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 no tiene permiso o la solicitud está bloqueada por la lista de permitidos Confirma que la clave tiene el permiso data_objects.object_relationships.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 Vuelve a intentarlo después de X-RateLimit-Reset y reduce la frecuencia de las solicitudes.
New Stuff!