Update lead overview

PUT

/api/nova/leads/{leadId}/overview

Replaces the overview (description) text of a lead with the text supplied in the request body. The existing text is overwritten in full rather than appended to. Returns 404 when the lead is not found and the lead id on success. Responds with 401 for an invalid API key and 429 when API usage limits are exceeded.

Authorizations

privateApiKey

Type

API Key (query: apiKey)

Parameters

Path Parameters

leadId*

leadId

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/leads/{leadId}/overview

Playground

Authorization

privateApiKey

Variables

Key

Value

leadId*

apiKey*

Body

Samples