Appearance
Add candidate to pipeline
POST
/api/nova/jobs/{jobId}/pipeline
Attaches a candidate to the pipeline of the job identified by the jobId path variable. The request body must include candidateId and may include statusCode to choose the stage (SOURCED, APPLIED, SHORTLIST, CV_SENT, INTERVIEW, OFFER or PLACED; defaults to SOURCED) and an optional stateId for swimlane or sub-state placement. The call is idempotent: if the candidate is already in the job's pipeline the existing entry's ID is returned with the message Already exists instead of creating a duplicate. Writes go through the same pipeline service as the kanban UI, so webhooks, scorecards and the board stay in sync. Returns the new pipeline entry's ID with the message Created on success; 400 for a missing candidateId or an invalid statusCode, 404 if the job or candidate is not found, 429 if rate limited, 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
Requiredstring
Query Parameters
apiKey*
apiKey
Type
Requiredstring
Request Body
application/json
JSON "candidateId": "string", "stateId": "string", "statusCode": "string"
{
}
Responses
OK
application/json
JSON "data": "string", "error": "string", "message": "string", "requestId": "string", "success": true
{
}