Reemplazar relación de objeto

Usa este endpoint para crear o reemplazar una relación de objeto.

Importante

Data Objects se encuentra actualmente en acceso anticipado. Tu espacio de trabajo debe estar habilitado antes de que los permisos de clave de API de Data Objects aparezcan en Configuración > Claves de API.

Requisitos previos

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

Límite de velocidad

Este endpoint se encuentra en el contenedor de escritura de Data Objects 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}/object_relationships.

Parámetros de la solicitud

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

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

1
2
3
4
5
6
7

{
  "rel_kind": "subaccount",
  "related_type_name": "account",
  "related_external_id": "acct-456",
  "anchor": "source",
  "attributes": {}
}

Solicitud cURL de ejemplo

Este ejemplo reemplaza la relación subaccount entre acct-123 y acct-456, sobrescribiendo cualquier atributo almacenado previamente en ella.

1
2
3
4
5
6
7
8
9
10

curl --location --request PUT '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_external_id": "acct-456",
  "anchor": "source",
  "attributes": {}
}'

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 200 podría devolver el siguiente cuerpo de respuesta.

1
2
3
4
5
6
7
8
9
10
11

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

Parámetros de respuesta

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

Errores

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