Actualizar relación de usuario

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

Importante

Los objetos de datos están disponibles de forma general, pero tu espacio de trabajo debe estar aprovisionado para Cuentas antes de que puedas utilizar este endpoint. Para solicitar el aprovisionamiento, ve a Configuración de datos > Cuentas y completa el cuestionario. Para más detalles, consulta Habilitar Cuentas.

Requisitos previos

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

Límite de velocidad

Este endpoint se encuentra en el 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 del endpoint /data_objects/objects/{type_name}/{object_id}/users.

Parámetros de solicitud

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

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

{
  "braze_id": "507f1f77bcf86cd799439011",
  "rel_kind": "account_user",
  "attributes": {
    "role": "billing_admin"
  }
}

Solicitud cURL de ejemplo

Este ejemplo cambia a billing_admin el atributo role de la relación account_user existente, sin modificar los demás atributos de la relación.

1
2
3
4
5
6
7
8
9
10

curl --location --request PATCH 'https://rest.iad-01.braze.com/data_objects/objects/account/acct-123/users' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "braze_id": "507f1f77bcf86cd799439011",
  "rel_kind": "account_user",
  "attributes": {
    "role": "billing_admin"
  }
}'

Respuesta

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

Ejemplo de respuesta correcta

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

1
2
3
4
5
6
7
8
9

{
  "user_relationship": {
    "type_name": "account",
    "object_id": "acct-123",
    "rel_kind": "account_user",
    "user": { "braze_id": "507f1f77bcf86cd799439011" },
    "attributes": { "role": "billing_admin" }
  }
}

Parámetros de respuesta

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

Errores

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