Create Company Permission | BigCommerce Developer Center

Create a custom Company permission.

Note that the permission’s name and code values cannot match an existing permission.

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. |

Request

This endpoint expects an object.

codestringRequired<=50 characters

The code string of the Company permission.

descriptionstringRequired<=512 characters

The simple description for the Company permission. See Permission Codes for a more detailed description of each predefined Company permission.

namestringRequired<=200 characters

The name of the Company permission.

moduleNamestringOptional<=50 characters

The name of the module to which the permission belongs. This corresponds to the organizational section containing the permission when managing Company roles from the B2B Edition control panel.

Response

codeintegerDefaults to 200

dataobject

metaobject

1	import requests
2
3	url = "https://api-b2b.bigcommerce.com/api/v3/io/companies/permissions"
4
5	payload = {
6	"code": "get_addresses",
7	"description": "Get addresses",
8	"name": "Get addresses",
9	"moduleName": "address"
10	}
11	headers = {
12	"X-Auth-Token": "<apiKey>",
13	"Content-Type": "application/json"
14	}
15
16	response = requests.post(url, json=payload, headers=headers)
17
18	print(response.json())

1	{
2	"code": 200,
3	"data": {
4	"code": "get_addresses",
5	"description": "Get addresses",
6	"id": 1,
7	"isCustom": false,
8	"moduleName": "address",
9	"name": "Get addresses"
10	},
11	"meta": {
12	"message": "SUCCESS"
13	}
14	}