Update candidate overview

PUT

/api/nova/candidates/{candidateId}/overview

Replaces the candidate's overview text with the text field from the request body. Responds with 404 when the candidate does not exist, 401 for an invalid API key, and 429 when rate limited. Returns the candidate ID on success.

Authorizations

privateApiKey

Type

API Key (query: apiKey)

Parameters

Path Parameters

candidateId*

candidateId

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/candidates/{candidateId}/overview

Playground

Authorization

privateApiKey

Variables

Key

Value

candidateId*

apiKey*

Body

Samples