Crear relación de usuario

Usa este endpoint para vincular un usuario de Braze a un objeto de datos.

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.user_relationships.create.

Límite de velocidad

Este endpoint está 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}/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}/{external_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": "owner"
  }
}

Solicitud cURL de ejemplo

Este ejemplo vincula un usuario a acct-123 como account_user y registra su role como owner.

1
2
3
4
5
6
7
8
9
10

curl --location --request POST '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": "owner"
  }
}'

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.

1
2
3
4
5
6
7
8
9

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

Parámetros de respuesta

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

Errores

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