Skip to main content
POST
/
public
/
v2
/
companies
cURL
curl --request POST \
  --url https://api.example.com/public/v2/companies \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "<string>",
  "name": "<string>",
  "company_status": "<string>",
  "company_custom_fields": [
    {
      "field_name": "<string>",
      "field_value": "<string>"
    }
  ]
}
'
{
  "id": 123,
  "updated_time": "2023-11-07T05:31:56Z",
  "domain": "<string>",
  "previous_status": "<string>",
  "status_changed_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "company_status": "<string>",
  "company_custom_fields": [
    {
      "id": 123,
      "updated_time": "2023-11-07T05:31:56Z",
      "field_name": "<string>",
      "field_value": "<string>"
    }
  ]
}

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.

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