HUhubspot
Basic

Create a user

Changed on

Create a new user in your HubSpot account using the specified details. This endpoint requires a JSON request body with user information such as email, first name, last name, role, and seats. A welcome email can be optionally sent to the new user.

post/settings/users/2026-09

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/settings/users/2026-09
  • Auth
    • OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: settings.users.write
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.users.write

Request body

emailstring required

The email address of the user being provisioned. This is a required field and must be unique.

firstNamestring

The first name of the user.

lastNamestring

The last name of the user.

primaryTeamIdstring

The identifier for the primary team to which the user belongs.

roleIdstring

The identifier for the role assigned to the user.

seatNamesstring[]

An array of seat names assigned to the user, representing different permissions or access levels.

secondaryTeamIdsstring[]

An array of identifiers for secondary teams to which the user is associated.

sendWelcomeEmailboolean required

A boolean indicating whether a welcome email should be sent to the user upon provisioning. This is a required field.

Response

successful operation

emailstring required

The email address of the user. This is a required field and must be unique.

firstNamestring

The first name of the user, represented as a string.

idstring required

The unique identifier for the user, represented as a string.

lastNamestring

The last name of the user, represented as a string.

primaryTeamIdstring

The ID of the primary team to which the user belongs, represented as a string.

roleIdstring

A string representing a single role ID assigned to the user.

roleIdsstring[] required

An array of strings representing the IDs of the roles assigned to the user. This is a required field.

seatNamesstring[]

An array of strings representing the names of seats assigned to the user.

secondaryTeamIdsstring[]

An array of strings representing the IDs of secondary teams to which the user is associated.

sendWelcomeEmailboolean

A boolean indicating whether a welcome email should be sent to the user.

superAdminboolean required

A boolean indicating whether the user has super admin privileges. This is a required field.

Changes

  • 2026-099aa42e094343Revision changes
    • info

      the security scope settings.users.write was added to the endpoint's security scheme oauth2

    • info

      the security scope crm.objects.users.write was removed from the endpoint's security scheme oauth2

  • 2026-091ec62479c06aRevision changes
    • info

      the security scope crm.objects.users.write was added to the endpoint's security scheme oauth2

    • info

      the security scope settings.users.write was removed from the endpoint's security scheme oauth2