Skip to main content
POST
/
settings
/
v3
/
users
Adds a user
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
}

Supported products

Requires one of the following products or higher.
Marketing HubMarketing Hub -Free
Sales HubSales Hub -Free
Service HubService Hub -Free
Content HubContent Hub -Free
Data HubData Hub -Free

Authorizations

Authorization
string
header
required

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

Body

application/json
email
string
required

The user's email.

sendWelcomeEmail
boolean
required

Whether to send a welcome email.

firstName
string

The user's first name.

lastName
string

The user's last name.

primaryTeamId
string

The user's primary team.

roleId
string

The user's role.

secondaryTeamIds
string[]

The user's additional teams.

Response

successful operation

email
string
required

The user's email.

id
string
required

The user's unique ID.

roleIds
string[]
required

A list of role IDs assigned to the user.

superAdmin
boolean
required

Whether the user has super admin privileges.

firstName
string

The user's first name.

lastName
string

The user's last name.

primaryTeamId
string

The user's primary team

roleId
string

The user's role.

secondaryTeamIds
string[]

The user's additional teams.

sendWelcomeEmail
boolean

Whether a welcome email was sent to the user. This value will only be populated in response to a provisioning request. Subsequent queries will be false.

Last modified on February 12, 2026