Update company overview

PUT

/api/nova/companies/{companyId}/overview

Replaces the company's overview, also known as the client description, with the text supplied in the request body. The text field is written as-is to the company record. Returns 404 if the company does not exist. On success the response contains the company ID with a confirmation message.

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

{

  

"text": "string"

}

Responses

OK

Content-Type

application/json

{

  

"data": "string",

  

"error": "string",

  

"message": "string",

  

"requestId": "string",

  

"success": true

}

PUT

/api/nova/companies/{companyId}/overview

Playground

Authorization

privateApiKey

Variables

Key

Value

companyId*

apiKey*

Body

Samples