Criar relacionamento de usuário

Use este endpoint para vincular um usuário da Braze a um objeto de dados.

Importante

Data Objects está atualmente em acesso antecipado. Seu espaço de trabalho precisa ser ativado antes que as permissões de chave de API de Data Objects apareçam em Configurações > Chaves de API.

Pré-requisitos

Para usar este endpoint, você precisa de uma chave de API com a permissão data_objects.user_relationships.create.

Limite de frequência

Este endpoint está no bucket de escrita de Data Objects com um limite padrão de 50 solicitações por minuto.

Parâmetros de caminho

A tabela a seguir lista e descreve os parâmetros de caminho para o endpoint /data_objects/objects/{type_name}/{external_id}/users.

Parâmetros de solicitação

A tabela a seguir lista e descreve os parâmetros do corpo da solicitação JSON para o endpoint /data_objects/objects/{type_name}/{external_id}/users.

Exemplo de solicitação

Esta seção inclui um exemplo de carga útil JSON e um exemplo de solicitação cURL.

Exemplo de carga útil da solicitação

1
2
3
4
5
6
7
{
  "braze_id": "507f1f77bcf86cd799439011",
  "rel_kind": "account_user",
  "attributes": {
    "role": "owner"
  }
}

Exemplo de solicitação cURL

Este exemplo vincula um usuário a acct-123 como account_user e registra o 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"
  }
}'

Resposta

Esta seção inclui um exemplo de resposta bem-sucedida e os campos da resposta.

Exemplo de resposta bem-sucedida

O código de status 201 pode retornar o seguinte corpo de resposta.

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 resposta

A tabela a seguir lista e descreve os campos em uma resposta bem-sucedida.

Erros

A tabela a seguir lista os erros comuns para este endpoint e como resolvê-los.