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": "newUser@email.com",
  "roleId": "100",
  "primaryTeamId": "101",
  "secondaryTeamIds": [
    "102"
  ],
  "sendWelcomeEmail": "true"
}
'
{
  "id": "123",
  "email": "newUser@email.com",
  "roleId": "100",
  "primaryTeamId": "101",
  "secondaryTeamIds": [
    "102"
  ],
  "superAdmin": "false"
}

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

A user creation request

email
string
required

The user's 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.

sendWelcomeEmail
boolean

Whether to send a welcome email.

Response

successful operation

A user

email
string
required

The user's email.

id
string
required

The user's unique ID.

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.

roleIds
string[]

A list of role IDs assigned to the user.

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.

superAdmin
boolean

Whether the user has super admin privileges.

Last modified on December 16, 2025