Request
This endpoint expects an object.
channelIdslist of integersOptional
An array of unique channel IDs associated with BigCommerce sales channels. The account will only be able to login on channels in this list.
emailstringOptionalformat: "email"
The email address associated with the Super Admin's BigCommerce customer account.
extraFieldslist of objectsOptional
firstNamestringOptional
The first name listed on the Super Admin's BigCommerce customer account.
lastNamestringOptional
The last name listed on the Super Admin's BigCommerce customer account.
originChannelIdintegerOptional
The unique BigCommerce channel ID, used for the BigCommerce customer account's origin channel. This field is inactive if the store has a default B2B Edition channel set.
phonestringOptional
The phone number listed on the Super Admin's BigCommerce customer account.
uuidstringOptionalformat: "uuid"
An external ID associated with the Super Admin account. B2B Edition does not require UUID to be unique, despite the field's label. B2B Edition will not assign a UUID by default.
> NOTE
> Some endpoints will only return this field if it has a non-empty value. If your code relies on the presence of a UUID in responses, ensure it is defined for each user, and prefer endpoints that provide more details.
>
> Regardless of individual user status, make sure to check for existence before attempting to use the value of the `uuid` field.
Response
SUCCESS
codeintegerDefaults to 200
