Pular para o conteúdo principal
POST
/
settings
/
v3
/
users
Adiciona um usuário
curl --request POST \
  --url https://api.hubapi.com/settings/v3/users/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "sendWelcomeEmail": true,
  "firstName": "<string>",
  "lastName": "<string>",
  "primaryTeamId": "<string>",
  "roleId": "<string>",
  "secondaryTeamIds": [
    "<string>"
  ]
}
'
{
  "email": "<string>",
  "id": "<string>",
  "roleIds": [
    "<string>"
  ],
  "superAdmin": true,
  "firstName": "<string>",
  "lastName": "<string>",
  "primaryTeamId": "<string>",
  "roleId": "<string>",
  "secondaryTeamIds": [
    "<string>"
  ],
  "sendWelcomeEmail": true
}

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.

Corpo

application/json
email
string
obrigatório

O e-mail do usuário.

sendWelcomeEmail
boolean
obrigatório

Se deve ou não enviar um e-mail de boas-vindas.

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

email
string
obrigatório

O e-mail do usuário.

id
string
obrigatório

O ID exclusivo do usuário.

roleIds
string[]
obrigatório

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

superAdmin
boolean
obrigatório

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

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.

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.

Last modified on March 24, 2026