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

Update Company Role

Beta
PUT
https://api-b2b.bigcommerce.com/api/v3/io/companies/roles/:roleId
PUT
/api/v3/io/companies/roles/:roleId
$curl -X PUT https://api-b2b.bigcommerce.com/api/v3/io/companies/roles/1 \
>     -H "authToken: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "name": "io test",
>  "permissions": [
>    {
>      "code": "get_addresses",
>      "permissionLevel": 2
>    }
>  ]
>}'
200Example 1
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}
Update company role - Predefined roles cannot be updated. - Permissions only support full updates. Please provide all the permission codes required for the role.
Was this page helpful?
Previous

Get Company Role Detail

Next

Delete Company Role

Built with

Update company role

  • Predefined roles cannot be updated.
  • Permissions only support full updates. Please provide all the permission codes required for the role.

Authentication

authTokenstring

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

Path parameters

roleIdintegerRequired

Request

This endpoint expects an object.
namestringRequired<=200 characters
permissionslist of objectsRequired
Permissions only support full update

Response

OK
codeinteger
dataobject
metaobject