Update candidate status

PUT

/api/nova/candidates/{candidateId}/status

Sets a candidate's status to one of the candidate status master data values. The statusId field is required and must reference an existing candidate status; an optional comments field is recorded with the change. Responds with 400 when statusId is missing, 404 when the candidate or status cannot be found, and 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

{

  

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

Playground

Authorization

privateApiKey

Variables

Key

Value

candidateId*

apiKey*

Body

Samples