Create Company
Create a new company record associated with a customer base.
POST /external/v1/external/v1/customers/companies
Request
Parameters
None
Request Body
The request body is a JSON object containing the new company's details.
Content Type: application/json
company_name
string
The official name of the company.
"Acme Corp Ltd"
Yes
company_status
string
The operational status of the company.
"active"
No
description
string
A brief description of the company or its business.
"Software development firm."
No
industry
string
The industry the company operates in.
"Technology"
No
website
string
The company's main website URL.
"https://www.acmecorp.com"
No
phone
string
The company's primary phone number.
"1-555-123-4567"
No
address
string
The company's physical street address.
"123 Corporate Ave"
No
Example Request Body:
{
"company_name": "Acme Corp Ltd",
"company_email": "[email protected]",
"company_status": "active",
"description": "Software development firm.",
"industry": "Technology",
"website": "[https://www.acmecorp.com](https://www.acmecorp.com)",
"phone": "1-555-123-4567",
"address": "123 Corporate Ave, City, Country"
}Responses
201 Successful Response (Created)
Returns the newly created company object, including system-generated IDs and timestamps.
Content Type: application/json
Field
Type
Description
id
integer
The internal database ID of the company.
company_id
string
The unique external ID assigned to the company.
time_created
string (datetime)
The timestamp when the company record was created.
time_updated
string (datetime)
The timestamp when the company record was last updated.
organization_id
integer
The organization ID this company belongs to.
... other fields
...
All fields from the request body are also returned.
Example Response Body (201):
422 Validation Error
Returned if the request body is malformed or contains invalid data (e.g., missing required fields).
Content Type: application/json
Field
Type
Description
detail
Array of Objects
A list of validation error objects.
Example Response Body (422):
Last updated