Create Company

Create a new customer company under your organization. Requires an API key.

Creating a new company

Create Company

post

Creates a company scoped to the authenticated organization.

Body
company_namestringRequired

Name of the company.

company_statusstring · enumRequired

Status of the company (e.g., active, inactive).

Possible values:
descriptionstringOptional

Brief description of the company.

industrystringOptional

Industry to which the company belongs.

websitestringOptional

Website URL of the company.

phonestringOptional

Contact phone number.

addressstringOptional

Physical address of the company.

Responses
201

Company created successfully.

application/json
post
/external/v1/external/v1/customer/company/create
POST /external/v1/external/v1/customer/company/create HTTP/1.1
Host: api.cuoral.com
Content-Type: application/json
Accept: */*
Content-Length: 137

{
  "company_name": "text",
  "company_status": "active",
  "description": "text",
  "industry": "text",
  "website": "text",
  "phone": "text",
  "address": "text"
}
{
  "company_name": "text",
  "company_status": "text",
  "description": "text",
  "industry": "text",
  "website": "text",
  "phone": "text",
  "address": "text",
  "id": 1,
  "company_id": "xyz-123"
}

Bulk Create Customer Companies

post

Allows authenticated organizations to create multiple companies in one request.

Body
Responses
200

Companies created successfully.

application/json
ResponsestringExample: Companies successfully created.
post
/external/v1/external/v1/customer/company/bulk-create
POST /external/v1/external/v1/customer/company/bulk-create HTTP/1.1
Host: api.cuoral.com
Content-Type: application/json
Accept: */*
Content-Length: 153

{
  "companies": [
    {
      "company_name": "text",
      "company_status": "active",
      "description": "text",
      "industry": "text",
      "website": "text",
      "phone": "text",
      "address": "text"
    }
  ]
}
Companies successfully created.
PreviousCustomersNextSMS

Last updated