Delete a candidate

DELETE

/api/nova/candidates/{candidateId}

Deletes the candidate with the given ID. The candidate is looked up first, so a missing record responds with 404 rather than deleting silently. Returns the deleted candidate's ID on success, 401 for an invalid API key, and 429 when rate limited.

Authorizations

privateApiKey

Type

API Key (query: apiKey)

Parameters

Path Parameters

candidateId*

candidateId

Type

string

Required

Query Parameters

apiKey*

apiKey

Type

string

Required

Responses

OK

Content-Type

application/json

{

  

"data": "string",

  

"error": "string",

  

"message": "string",

  

"requestId": "string",

  

"success": true

}

DELETE

/api/nova/candidates/{candidateId}

Playground

Authorization

privateApiKey

Variables

Key

Value

candidateId*

apiKey*

Samples