Create Company Role

POST

https://api-b2b.bigcommerce.com/api/v3/io/companies/roles

Create a custom Company user role. When adding predefined Company permissions to a user role, refer to [Permission Codes](/developer/api-reference/rest/b2b/management/company/companies#permission-codes) for their `name` and `code` values. Some permissions require prerequisites that must also be enabled in the role, and assigned to the same or higher permission level. See [B2B Edition Buyer Roles and Permissions](https://support.bigcommerce.com/s/article/Buyer-Roles-and-Permissions) in the Help Center to learn more.

Create Company Role

POST

https://api-b2b.bigcommerce.com/api/v3/io/companies/roles

Create a custom Company user role.

When adding predefined Company permissions to a user role, refer to Permission Codes for their name and code values.

Some permissions require prerequisites that must also be enabled in the role, and assigned to the same or higher permission level. See B2B Edition Buyer Roles and Permissions in the Help Center to learn more.

Authentication

X-Auth-Tokenstring

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

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

X-Store-Hashstring

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

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

$	curl -X POST https://api-b2b.bigcommerce.com/api/v3/io/companies/roles \
>	-H "X-Auth-Token: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "io test",
>	"permissions": [
>	{
>	"code": "get_addresses",
>	"permissionLevel": 2
>	}
>	]
>	}'

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	}

$	curl -X POST https://api-b2b.bigcommerce.com/api/v3/io/companies/roles \
>	-H "X-Auth-Token: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "io test",
>	"permissions": [
>	{
>	"code": "get_addresses",
>	"permissionLevel": 2
>	}
>	]
>	}'

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	}