Atualizar relacionamento de usuário

Use este endpoint para mesclar atributos em um relacionamento de usuário existente.

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 mais detalhes, 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 do Data Objects, com um limite padrão de 1.000 requisiçõ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}/{object_id}/users.

Parâmetros de requisição

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

Identificação do usuário

• Informe exatamente um identificador em user. Nenhum identificador não nulo, ou mais de um, retorna 400. Campos de identificador nulos junto com um identificador válido são aceitos.
• Se um e-mail ou número de telefone corresponder a mais de um perfil de usuário, a Braze escolhe o usuário identificado (aquele com um external_id). Se ainda houver empate, a Braze escolhe o perfil atualizado mais recentemente.
• Use external_id sempre que disponível.

Exemplo de requisição

Esta seção inclui uma carga útil JSON de exemplo e uma requisição cURL de exemplo.

Carga útil de requisição de exemplo

1
2
3
4
5
6
7
8
9

{
  "user": {
    "external_id": "user-123"
  },
  "rel_kind": "account_user",
  "attributes": {
    "role": "billing_admin"
  }
}

Exemplo alternativo usando alias de usuário:

1
2
3
4
5
6
7
8
9
10
11
12

{
  "user": {
    "alias": {
      "alias_name": "[email protected]",
      "alias_label": "crm_email"
    }
  },
  "rel_kind": "account_user",
  "attributes": {
    "role": "billing_admin"
  }
}

Requisição cURL de exemplo

Este exemplo altera o atributo role no relacionamento account_user existente para billing_admin, mantendo os demais atributos do relacionamento inalterados.

1
2
3
4
5
6
7
8
9
10
11
12

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 '{
  "user": {
    "external_id": "user-123"
  },
  "rel_kind": "account_user",
  "attributes": {
    "role": "billing_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
10
11
12

{
  "user_relationship": {
    "type_name": "account",
    "object_id": "acct-123",
    "rel_kind": "account_user",
    "user": {
      "external_id": "user-123",
      "braze_id": "507f1f77bcf86cd799439011"
    },
    "attributes": { "role": "billing_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.