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 HubFree
Sales HubSales HubFree
Service HubService HubFree
Content HubContent HubFree

​
Required Scopes

This API requires one of the following scopes:
  • crm.objects.users.write
  • settings.users.write

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

Response

201
application/json

successful operation

A user