Skip to main content
POST
cURL

Query Parameters

structure
enum<string>
default:NESTED

Format of custom fields in response. NESTED returns array of objects with id, field_name, field_value. FLAT returns object with field names as keys.

Available options:
FLAT,
NESTED

Body

domain
string
required
name
string
company_status
string
company_custom_fields
object[]

Response

Created. The company was successfully created. If a company with this domain already exists for the client, this endpoint still returns 201, with body {"id": <existing_company_id>, "duplicate": "YES", "warning": "A Company with this domain already exists for this client"} instead of creating a new record — check the response body, not the status code, to detect a duplicate.

id
integer
required
read-only
updated_time
string<date-time>
required
read-only
domain
string
required
previous_status
string | null
required
read-only
status_changed_at
string<date-time> | null
required
read-only
name
string
company_status
string
company_custom_fields
object[]