Pular para o conteúdo principal
PUT
/
settings
/
v3
/
users
/
{userId}
Modificar um usuário
curl --request PUT \
  --url https://api.hubapi.com/settings/v3/users/{userId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "roleId": "100",
  "primaryTeamId": "101",
  "secondaryTeamIds": [
    "102"
  ]
}
'
{
  "id": "123",
  "email": "[email protected]",
  "roleId": "100",
  "primaryTeamId": "101",
  "secondaryTeamIds": [
    "102"
  ],
  "superAdmin": "false"
}

Produtos suportados

Requer um dos seguintes produtos ou superior.
Marketing HubMarketing Hub -Grátis
Sales HubSales Hub -Grátis
Service HubService Hub -Grátis
Content HubContent Hub -Grátis

Autorizações

Authorization
string
header
obrigatório

The access token received from the authorization server in the OAuth 2.0 flow.

Parâmetros de caminho

userId
string
obrigatório

Identificador do usuário a ser recuperado

Parâmetros de consulta

idProperty
enum<string>

O nome de uma propriedade com valores de usuário exclusivos. Valores válidos são "USER_ID" (padrão) ou "EMAIL"

Opções disponíveis:
EMAIL,
USER_ID

Corpo

application/json

A user to update

firstName
string

O nome do usuário.

lastName
string

O sobrenome do usuário.

primaryTeamId
string

A equipe principal do usuário.

roleId
string

A função do usuário.

secondaryTeamIds
string[]

As equipes adicionais do usuário.

Resposta

successful operation

A user

email
string
obrigatório

O e-mail do usuário.

id
string
obrigatório

O ID exclusivo do usuário.

firstName
string

O nome do usuário.

lastName
string

O sobrenome do usuário.

primaryTeamId
string

A equipe principal do usuário

roleId
string

A função do usuário.

roleIds
string[]

Uma lista dos IDs de função atribuídos ao usuário.

secondaryTeamIds
string[]

As equipes adicionais do usuário.

sendWelcomeEmail
boolean

Indica se um e-mail de boas-vindas foi enviado ao usuário. Este valor será preenchido apenas em resposta a uma solicitação de provisionamento. Consultas subsequentes retornarão falso.

superAdmin
boolean

Se o usuário tem privilégios de superadministrador.

Last modified on December 8, 2025