RESTB2BManagementCompany Roles and Permissions

Update Company Permission

Updates an existing custom Company permission. Predefined permissions cannot be updated.

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](/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).
OR
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. |

Path parameters

permissionIdstringRequired

Request

The name and code are unique within the same store.
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

OK
codeintegerDefaults to 200
dataobject
metaobject