For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
  • Overview
    • Quick Start
    • Sandboxes
    • Tools & SDKs
    • Support
  • Docs
    • Archive
    • Closed Beta Programs
        • Overview
        • API Reference
              • GETList Company Permissions
              • POSTCreate Company Permission
              • PUTUpdate Company Permission
              • DELDelete Company Permission
              • GETList Company Roles
              • POSTCreate Company Role
              • GETGet Company Role Detail
              • PUTUpdate Company Role
              • DELDelete Company Role
Dev Portal
LogoLogo
Closed Beta ProgramsB2B Edition UpdatesAPI ReferenceCompany Roles and Permissions

Create Company Permission

Beta
POST
https://api-b2b.bigcommerce.com/api/v3/io/companies/permissions
POST
/api/v3/io/companies/permissions
$curl -X POST https://api-b2b.bigcommerce.com/api/v3/io/companies/permissions \
> -H "authToken: <apiKey>" \
> -H "Content-Type: application/json" \
> -d '{
> "name": "Get addresses",
> "code": "get_addresses",
> "description": "Get addresses",
> "moduleName": "address"
>}'
200Example 1
1{
2 "code": 200,
3 "data": {
4 "id": 1,
5 "name": "Get addresses",
6 "code": "get_addresses",
7 "description": "Get addresses",
8 "isCustom": false,
9 "moduleName": "address"
10 },
11 "meta": {
12 "message": "SUCCESS"
13 }
14}
Create company permission
Was this page helpful?
Previous

List Company Permissions

Next

Update Company Permission

Built with

Authentication

authTokenstring

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

Request

name, code is unique in the same store.
namestringRequired<=200 characters
The permission name
codestringRequired<=50 characters
The permission code
descriptionstringRequired<=512 characters
The permission description
moduleNamestringOptional<=50 characters
The permission module name

Response

OK
codeintegerDefaults to 200
dataobject
metaobject