Update company status

PUT

/api/nova/companies/{companyId}/status

Sets the status of a company to the status master record identified by statusId in the request body. statusId is required and a 400 is returned if it is blank. Returns 404 if either the company or the status record cannot be found. 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

{

  

"comments": "string",

  

"reasonId": "string",

  

"statusId": "string"

}

Responses

OK

Content-Type

application/json

{

  

"data": "string",

  

"error": "string",

  

"message": "string",

  

"requestId": "string",

  

"success": true

}

PUT

/api/nova/companies/{companyId}/status

Playground

Authorization

privateApiKey

Variables

Key

Value

companyId*

apiKey*

Body

Samples