HubSpot: Create a user

← User provisioning operations · Get started

Operation hubspot.user_provisioning_create_user

Provider route: POST /settings/users/2026-09. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";

async function execute(input: Parameters<HubSpotIntegration["userProvisioning"]["createUser"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.userProvisioning.createUser(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.user_provisioning.create_user(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	Model	Required within parent	Expand Create a user — request body — body

Referenced models: Create a user — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Create a user — response body

Referenced models: Create a user — response body

Schemas

Create a user — response body

Field	Type	Presence	Description and constraints
$	object	Root
email	string	Required within parent	The email address of the user. This is a required field and must be unique.
firstName	string	Optional	The first name of the user, represented as a string.
id	string	Required within parent	The unique identifier for the user, represented as a string.
lastName	string	Optional	The last name of the user, represented as a string.
primaryTeamId	string	Optional	The ID of the primary team to which the user belongs, represented as a string.
roleId	string	Optional	A string representing a single role ID assigned to the user.
roleIds	array	Required within parent	An array of strings representing the IDs of the roles assigned to the user. This is a required field.
roleIds[]	string	Each item
seatNames	array	Optional	An array of strings representing the names of seats assigned to the user.
seatNames[]	string	Each item
secondaryTeamIds	array	Optional	An array of strings representing the IDs of secondary teams to which the user is associated.
secondaryTeamIds[]	string	Each item
sendWelcomeEmail	boolean	Optional	A boolean indicating whether a welcome email should be sent to the user.
superAdmin	boolean	Required within parent	A boolean indicating whether the user has super admin privileges. This is a required field.

Create a user — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
email	string	Required within parent	The email address of the user being provisioned. This is a required field and must be unique.
firstName	string	Optional	The first name of the user.
lastName	string	Optional	The last name of the user.
primaryTeamId	string	Optional	The identifier for the primary team to which the user belongs.
roleId	string	Optional	The identifier for the role assigned to the user.
seatNames	array	Optional	An array of seat names assigned to the user, representing different permissions or access levels.
seatNames[]	string	Each item
secondaryTeamIds	array	Optional	An array of identifiers for secondary teams to which the user is associated.
secondaryTeamIds[]	string	Each item
sendWelcomeEmail	boolean	Required within parent	A boolean indicating whether a welcome email should be sent to the user upon provisioning. This is a required field.

Policy, approvals and errors

SDK function policy ID: hubspot.user_provisioning_create_user. Catalog operation: user_provisioning_create_user. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["crm.objects.users.write", "settings.users.write"]

Official provider source