Update Company Role | BigCommerce Developer Center

Updates the name and permissions of a custom Company user role. You cannot update predefined roles.

When formatting the request body, you must add all permissions that you wish to keep in the role, including its existing permissions. See Permission Codes for a list of predefined permission name and code values.

Updates the name and permissions of a custom Company user role. You cannot update predefined roles. When formatting the request body, you must add all permissions that you wish to keep in the role, including its existing permissions. See [Permission Codes](/developer/api-reference/rest/b2b/management/company/companies#permission-codes) for a list of predefined permission `name` and `code` values.

Authentication

X-Auth-Tokenstring

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

X-Store-Hashstring

Authentication header

Header	Argument	Description
`X-Store-Hash`	`store_hash`	The unique store hash associated with a BigCommerce store that has B2B Edition enabled.

### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Store-Hash` | `store_hash` | The unique store hash associated with a BigCommerce store that has B2B Edition enabled. |

Path parameters

roleIdstringRequired

Request

This endpoint expects an object.

namestringRequired<=200 characters

The name of the Company user role. This name is visible to system users and Company users.

permissionslist of objectsRequired

Response

codeinteger

dataobject

metaobject

1	curl -X PUT https://api-b2b.bigcommerce.com/api/v3/io/companies/roles/roleId \
2	-H "X-Auth-Token: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "io test",
6	"permissions": [
7	{
8	"code": "get_addresses",
9	"permissionLevel": 2
10	}
11	]
12	}'

1	{
2	"code": 200,
3	"data": {
4	"permissions": [
5	{
6	"id": 1,
7	"code": "get_addresses",
8	"permissionLevel": 2
9	}
10	],
11	"id": 1,
12	"name": "Procurement Manager",
13	"roleType": 2,
14	"roleLevel": 1
15	},
16	"meta": {
17	"message": "SUCCESS"
18	}
19	}