Update Company Role | BigCommerce Developer Center

Update company role

Predefined roles cannot be updated.
Permissions only support full updates. Please provide all the permission codes required for the role.

Update company role - Predefined roles cannot be updated. - Permissions only support full updates. Please provide all the permission codes required for the role.

Authentication

authTokenstring

Required to authenticate requests. Include the token in a header parameter called authToken.

Path parameters

roleIdstringRequired

Request

This endpoint expects an object.

namestringRequired<=200 characters

permissionslist of objectsRequired

Permissions only support full update

Response

codeinteger

dataobject

metaobject

1	import requests
2
3	url = "https://api-b2b.bigcommerce.com/api/v3/io/companies/roles/roleId"
4
5	payload = {
6	"name": "io test",
7	"permissions": [
8	{
9	"code": "get_addresses",
10	"permissionLevel": 2
11	}
12	]
13	}
14	headers = {
15	"authToken": "<apiKey>",
16	"Content-Type": "application/json"
17	}
18
19	response = requests.put(url, json=payload, headers=headers)
20
21	print(response.json())

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