Bulk Create Companies

Bulk create companies (up to 50 at a time).

POST /external/v1/external/v1/customers/companies/bulk

Parameters

  • None

Request Body (application/json)

The request body is a JSON object containing an array of company objects.

Field

Type

Description

Required

companies

Array of Objects

An array of up to 50 company objects to create.

Yes

Company Object Fields:

Field

Type

Description

company_name

string

The official name of the company.

company_email

string

A primary email address for the company.

company_status

string

The operational status (e.g., 'active').

description

string

A brief description.

industry

string

The company's industry.

website

string

The company's main website URL.

phone

string

The company's primary phone number.

address

string

The company's physical street address.

Example Request Body:

{
  "companies": [
    {
      "company_name": "Acme Corp",
      "company_email": "[email protected]",
      "company_status": "active",
      "description": "Manufacturing",
      "industry": "Manufacturing",
      "website": "https://www.acme.com",
      "phone": "555-1212",
      "address": "1 Main St"
    }
  ]
}

Successful Response (201) (application/json)

Field

Type

Description

created

integer

The count of companies successfully created.

companies

Array of Objects

The list of newly created company objects.

Created Company Object Fields (Includes all request fields plus):

Field

Type

Description

id

integer

The internal database ID.

company_id

string

The unique external ID.

time_created

string (datetime)

Creation timestamp.

time_updated

string (datetime)

Last update timestamp.

organization_id

integer

The organization ID.

Example Response Body (201):

JSON

Validation Error (422) (application/json)

Last updated