Update Company User | BigCommerce Developer Center

Update company user's field, user identified by email field.fields can not omit

Authentication

authTokenstring

API Key authentication via header

Path parameters

companyIdstringRequired

Request

This endpoint expects an object.

emailstringRequired

firstNamestringRequired

lastNamestringRequired

acceptWelcomeEmailenumOptional

(0=will not receive email 1=will receive email)

Allowed values:

channelIdslist of integersOptional

BigCommerce channel id list

companyRoleIdintegerOptional

The company role id. This field is only applicable to the company's RBAC feature. If your store doesn't utilize this feature, please do not use this field. When it has a value, it will override the value of the userRole field.

extraFieldslist of objectsOptional

phonestringOptional

userRolestringOptional

user role(0=admin 1=senior_buyer 2=junior_buyer 3=sales_rep)

uuidstringOptional

Response

Response Success

codedouble

Response status code

dataobject

Response data

messagestring

Response message

Errors

400

Bad Request Error

404

Not Found Error

1	curl -X PUT https://api-b2b.bigcommerce.com/api/v2/io/companies/companyId/users \
2	-H "authToken: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"email": "jane.doe@acmecorp.com",
6	"firstName": "Jane",
7	"lastName": "Doe"
8	}'

1	{
2	"code": 200,
3	"data": {
4	"customerId": "1024",
5	"userId": "2048"
6	},
7	"message": "Success"
8	}