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
        • V2 API
              • POSTCreate Company From CG
              • GETGet Company Basic Information
              • PUTUpdate Company Basic Information
              • DELDelete Company With Related
              • GETGet BC Order Id List By Company Id
              • GETGet Company By CustomerId
    • Closed Beta Programs
Dev Portal
LogoLogo
ArchiveB2B EditionV2 APICompany

Create Company From CG

Deprecated
POST
https://api-b2b.bigcommerce.com/api/v2/io/companies/convert-from-customer-group
POST
/api/v2/io/companies/convert-from-customer-group
$curl -X POST https://api-b2b.bigcommerce.com/api/v2/io/companies/convert-from-customer-group \
>     -H "authToken: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "adminEmail": "jane.smith@acmecorp.com",
>  "adminFirstName": "Jane",
>  "adminLastName": "Smith",
>  "companyEmail": "info@acmecorp.com",
>  "companyName": "Acme Corporation",
>  "customerGroupId": "4",
>  "phoneNumber": "+1-555-123-4567"
>}'
1{
2  "code": 200,
3  "data": {
4    "companyId": "2"
5  },
6  "message": "Success"
7}

Create company from bigCommerce customer group. This API only enable for non-MSF store.

Was this page helpful?
Previous

Delete A Company Address

Next

Get Company Basic Information

Built with

Authentication

authTokenstring
API Key authentication via header

Headers

authTokenstringRequired
Auth token in header.

Request

Request body
adminEmailstringRequired
Company admin user email
adminFirstNamestringRequired
Company admin user's first name
adminLastNamestringRequired
Company admin user's last name
companyEmailstringRequired
companyNamestringRequired
customerGroupIdstringRequired
BC customer group ID
phoneNumberstringRequired
acceptWelcomeEmailenumOptional

(0=will not receive email 1=will receive email)

Allowed values:
addressLine1stringOptional
Address string line 1
addressLine2stringOptional
Address string line 2
adminPhoneNumberstringOptional
Company admin user phone number
citystringOptional
countrystringOptional
extraFieldslist of objectsOptional

To use customized extra fields with field names you need to first add company extra fields in Settings > Extra fields inside B2B edition. eg. If you want to create a new company with an extra integer field named licenseNO, you can use this structure [{‘fieldName’: ‘LicenseNO’, ‘fieldValue’: 10342340323}] in the request body.

statestringOptional
zipCodestringOptional
userExtraFieldslist of objectsOptional

Response

Response Success
codedouble
Response status code
dataobject
Response data
messagestring
Response message

Errors

400
Bad Request Error
404
Not Found Error