Adds a user

POST /settings/v3/users/

Copy endpoint

https://api.hubapi.com

New users will only have minimal permissions, which is contacts-base. A welcome email will prompt them to set a password and log in to HubSpot.

Request Body

application/json required

interface UserProvisionRequest {
email: string;
firstName?: string;
lastName?: string;
primaryTeamId?: string;
roleId?: string;
secondaryTeamIds?: string[];
sendWelcomeEmail?: boolean;
}

Responses

201 application/json

successful operation

interface PublicUser {
email: string;
firstName?: string;
id: string;
lastName?: string;
primaryTeamId?: string;
roleId?: string;
roleIds?: string[];
secondaryTeamIds?: string[];
sendWelcomeEmail?: boolean;
superAdmin?: boolean;
}

default */*

An error occurred.

interface Error {
category: string;
context?: { };
correlationId: string;
errors?:

ErrorDetail

interface ErrorDetail {
code?: string;
context?: { };
in?: string;
message: string;
subCategory?: string;
}

[];
links?: { };
message: string;
subCategory?: string;
}