Update A Company User | BigCommerce Developer Center

Update a company user info

Authentication

authTokenstring

API Key authentication via header

Path parameters

companyIdstringRequired

userIdstringRequired

Request

This endpoint expects an object.

acceptWelcomeEmailstringOptional

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.

emailstringOptional

extraFieldslist of objectsOptional

firstNamestringOptional

lastNamestringOptional

phonestringOptional

userRolestringOptional

uuidstringOptional

Response

codedouble

Response status code

dataobject

Response data

messagestring

Response message

1	curl -X PUT https://api-b2b.bigcommerce.com/api/v2/io/companies/companyId/user/userId \
2	-H "authToken: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"code": 200,
3	"data": {
4	"customerId": 12345,
5	"userId": 67890
6	},
7	"message": "Company user information updated successfully."
8	}

Authentication

Path parameters

Headers

Request

Response