Skip to main content
PATCH
/
public
/
v2
/
companies
/
{company_id}
cURL
curl --request PATCH \
  --url https://api.example.com/public/v2/companies/{company_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "domain": "<string>",
  "company_status": "<string>",
  "company_custom_fields": [
    {
      "field_name": "<string>",
      "field_value": "<string>"
    }
  ]
}
'
{
  "name": "<string>",
  "domain": "<string>",
  "company_status": "<string>",
  "company_custom_fields": [
    {
      "field_name": "<string>",
      "field_value": "<string>"
    }
  ]
}

Path Parameters

company_id
integer
required

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

name
string
domain
string
company_status
string
company_custom_fields
object[]

Response

OK. The company was successfully updated.

name
string
domain
string
company_status
string
company_custom_fields
object[]