Skip to content

Update a company

PUT
/api/nova/companies/{companyId}

Updates an existing company identified by its ID. This is a partial update: only the fields supplied in the request body overwrite the current values, and omitted fields are left unchanged. Supported fields match the create endpoint, including name, contact details, social links, company metrics, client flag, rating, statusId and customFields. Returns 404 if the company does not exist, otherwise the response contains the updated company's ID.

Authorizations

privateApiKey
Type
API Key (query: apiKey)

Parameters

Path Parameters

companyId*

companyId

Type
string
Required

Query Parameters

apiKey*

apiKey

Type
string
Required

Request Body

application/json
JSON
{
  
"annualRevenue": 0,
  
"client": true,
  
"customFields": [
  
  
{
  
  
  
"boolValue": "string",
  
  
  
"dateValue": "string",
  
  
  
"fieldId": "string",
  
  
  
"fieldLabel": "string",
  
  
  
"listValue": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"value": "string"
  
  
}
  
],
  
"description": "string",
  
"domain": "string",
  
"email": "string",
  
"employeeCount": 0,
  
"facebook": "string",
  
"faxNo": "string",
  
"foundedYear": 0,
  
"id": "string",
  
"linkedIn": "string",
  
"name": "string",
  
"ownerId": "string",
  
"phone": "string",
  
"rating": 0,
  
"statusId": "string",
  
"tags": [
  
  
{
  
  
  
"group": "string",
  
  
  
"value": "string"
  
  
}
  
],
  
"twitter": "string",
  
"website": "string"
}

Responses

OK

application/json
JSON
{
  
"data": "string",
  
"error": "string",
  
"message": "string",
  
"requestId": "string",
  
"success": true
}

Playground

Authorization
Variables
Key
Value
Body

Samples

Recruitly — Recruitment CRM for Agencies