Update pipeline status

PUT

/api/nova/jobs/{jobId}/pipeline/{pipelineId}/status

Moves a pipeline entry, identified by the pipelineId path variable, to a different stage of the job identified by the jobId path variable. The request body must include statusCode (SOURCED, APPLIED, SHORTLIST, CV_SENT, INTERVIEW, OFFER or PLACED) and may include an optional stateId to also set a swimlane or sub-state. The entry must belong to the given job; a mismatch returns 404, as does an unknown pipelineId. Returns the updated pipeline entry with the message Updated on success; 400 for a missing or invalid statusCode, 401 for an invalid API key, and 500 with an error message on failure.

Authorizations

privateApiKey

Type

API Key (query: apiKey)

Parameters

Path Parameters

jobId*

jobId

Type

string

Required

pipelineId*

pipelineId

Type

string

Required

Query Parameters

apiKey*

apiKey

Type

string

Required

Request Body

application/json

{

  

"stateId": "string",

  

"statusCode": "string"

}

Responses

OK

Content-Type

application/json

{

  

"data": {

  

  

"candidateId": "string",

  

  

"candidateName": "string",

  

  

"createdOn": "string",

  

  

"id": "string",

  

  

"jobId": "string",

  

  

"rejected": true,

  

  

"stage": "string",

  

  

"status": "string"

  

},

  

"error": "string",

  

"message": "string",

  

"requestId": "string",

  

"success": true

}

PUT

/api/nova/jobs/{jobId}/pipeline/{pipelineId}/status

Playground

Authorization

privateApiKey

Variables

Key

Value

jobId*

pipelineId*

apiKey*

Body

Samples