Substituir relacionamento de usuário

Use este endpoint para criar ou substituir um relacionamento de usuário.

Importante

O Data Objects está disponível para todos, mas seu espaço de trabalho precisa estar provisionado para Accounts antes que você possa usar este endpoint. Para solicitar o provisionamento, acesse Configurações de dados > Accounts e preencha o questionário. Para saber mais, consulte Ativar Accounts.

Pré-requisitos

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

Limite de frequência

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

Parâmetros de caminho

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

Parâmetros de solicitação

A tabela a seguir lista e descreve os parâmetros do corpo da solicitação JSON do endpoint /data_objects/objects/{type_name}/{object_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 de solicitação

1
2
3
4
5
6
7

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

Exemplo de solicitação cURL

Este exemplo substitui os atributos do relacionamento account_user entre o usuário e acct-123, sobrescrevendo quaisquer atributos armazenados anteriormente nele.

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/users' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "braze_id": "507f1f77bcf86cd799439011",
  "rel_kind": "account_user",
  "attributes": {
    "role": "admin"
  }
}'

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 200 pode retornar o seguinte corpo de resposta.

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": "admin" }
  }
}

Parâmetros de resposta

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

Erros

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