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

Delete Company Permission

Beta
DELETE
https://api-b2b.bigcommerce.com/api/v3/io/companies/permissions/:permissionId
DELETE
/api/v3/io/companies/permissions/:permissionId
$curl -X DELETE https://api-b2b.bigcommerce.com/api/v3/io/companies/permissions/1 \
>     -H "authToken: <apiKey>"
200Example 1
1{
2  "data": {},
3  "code": 200,
4  "meta": {
5    "message": "SUCCESS"
6  }
7}
Delete company permission. Predefined permissions cannot be deleted.
Was this page helpful?
Previous

Update Company Permission

Next

List Company Roles

Built with

Authentication

authTokenstring

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

Path parameters

permissionIdintegerRequired

Response

OK
dataany
codeinteger
metaobject