Convert from BigCommerce CustomerGroup into Company

curl -X POST https://api-b2b.bigcommerce.com/api/v3/io/customer-groups/customerGroupId/companies \
     -H "authToken: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "companyName": "string",
  "companyPhone": "string",
  "companyEmail": "string",
  "country": "string",
  "adminEmail": "string",
  "adminPhoneNumber": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "city": "string",
  "state": "string",
  "zipCode": "string",
  "adminFirstName": "string",
  "adminLastName": "string",
  "catalogId": 0,
  "acceptCreationEmail": false,
  "extraFields": [
    {
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "description": "String"
}'

{
  "code": 200,
  "data": {
    "companyId": "12"
  },
  "meta": {
    "message": "SUCCESS"
  }
}

Create company from a BigCommerce customer group.

This API is turned off for the MSF store.
This API is turned off when the independent company feature is enabled.

Create company from a BigCommerce customer group. * This API is turned off for the MSF store. * This API is turned off when the independent company feature is enabled.

Authentication

authTokenstring

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

Path parameters

customerGroupIdstringRequired

Request

User Extra Field Values

companyNamestringRequired>=1 character

Company name

companyPhonestringRequired>=1 character

Company phone number

companyEmailstringRequired>=1 character

Company email

countrystringRequired>=1 character

adminEmailstringRequired>=1 character

adminPhoneNumberstringRequired>=1 character

addressLine1stringOptional>=1 character

addressLine2stringOptional>=1 character

citystringOptional>=1 character

statestringOptional>=1 character

zipCodestringOptional>=1 character

adminFirstNamestringOptional>=1 character

adminLastNamestringOptional>=1 character

catalogIdintegerOptional

The company catalog ID

acceptCreationEmailbooleanOptionalDefaults to false

If the company creation can accept email

extraFieldslist of objectsOptional

userExtraFieldslist of objectsOptional

Response

codeinteger

dataobject

metaobject

Errors

400

Bad Request Error

404

Not Found Error