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 Companies
              • POSTCreate Company
              • GETGet Company Detail
              • PUTUpdate Company
              • DELDelete Company
              • POSTConvert from BigCommerce CustomerGroup into Company
              • POSTBulk Create Companies
              • PUTUpdate Companies (batch)
              • PUTUpdate Company's Catalog
              • PUTUpdate Company's Status
              • GETList Company Extra Field Configs
              • GETList Company Attachments
              • POSTAdd Company Attachment
              • DELDelete Company Attachment
              • GETList Company Subsidiaries
              • DELDelete Company Subsidiary
              • POSTAttach Company as Parent to Current Company
              • GETList Company Hierarchy
Dev Portal
LogoLogo
Closed Beta ProgramsB2B Edition UpdatesAPI ReferenceCompany

Update Company's Status

Beta
PUT
https://api-b2b.bigcommerce.com/api/v3/io/companies/:companyId/status
PUT
/api/v3/io/companies/:companyId/status
$curl -X PUT https://api-b2b.bigcommerce.com/api/v3/io/companies/1/status \
> -H "authToken: <apiKey>" \
> -H "Content-Type: application/json" \
> -d '{
> "companyStatus": 1
>}'
200example-1
1{
2 "code": 200,
3 "data": {
4 "companyId": "147340"
5 },
6 "meta": {
7 "message": "SUCCESS"
8 }
9}
Update a company's status
Was this page helpful?
Previous

Update Company's Catalog

Next

List Company Extra Field Configs

Built with

Authentication

authTokenstring

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

Path parameters

companyIdintegerRequired
ID of company.

Request

companyStatusdoubleRequired

Company status you want to set 0: PENDING 1: APPROVED 2: REJECTED 3: INACTIVE 4: DELETED

Response

OK
codedouble
dataobject
metaobject