Create User

Creates a new user in a Company account. Equivalent Storefront GraphQL API Mutation: `userCreate`. For more information, see the [GraphQL Playground](https://api-b2b.bigcommerce.com/graphql/playground). If you enter an email address in the `email` field that is associated with a BigCommerce customer account, and the customer account does not already have a corresponding Company user account, it will link the existing customer account with the new Company user. If the email is not associated with a customer account, a new one will be created with the Company user. This endpoint will send a welcome email to the new user as if they had created their account via the Storefront UI. When you create an account this way, the user must reset their password to log in to the storefront unless they already have an existing BigCommerce customer account.

Authentication

AuthorizationBearer
### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| |`Authorization`|`Bearer {{B2B_JWT_TOKEN}}`| You can obtain this token using the steps described in the [REST Storefront API](/developer/docs/b2b-edition/getting-started/authentication#rest-storefront-api) section[...]

Request

This endpoint expects an object.
firstNamestringRequired
The user's first name.
lastNamestringRequired
The user's last name.
emailstringRequiredformat: "email"
The email address associated with the user's account.
companyIdstringRequired
Unique numeric ID of the Company account.
phoneNumberstringRequired
The phone number associated with the user's account.
roleenumRequired

The ID of the role assigned to the Company user account as defined at Specifying User Role.

Allowed values:

Response

OK
codedoubleDefaults to 200
dataobject
messagestringDefaults to SUCCESS