`PATCH` Move an Applicant between Track Stages¶

This API moves an applicant from one stage to another within the same track.

Request URL¶

PATCH /tracks/<track_id>/applicants/<application_id>/move

Body Parameters¶

{
    "source_stage_id": "string",
    "destination_stage_id": "string"
}

Warning

Make sure to add your API key in Header of the request

Parameters¶

Parameter	Type	Description
track_id	integer	ID of the track of the candidate
application_id	integer	ID of the applicant record to be moved
source_stage_id	string	Current stage ID of the applicant
destination_stage_id \| string		Target stage ID where the applicant should be moved

Response¶

A JSON response containing stage transition details after successful move.

{
    "track_id": "integer",
    "application_id": "integer",
    "candidate_id": "integer",
    "name": "string",
    "email": "string",
    "from_stage": {
        "stage_id": "string",
        "name": "string",
        "type": "string"
    },
    "to_stage": {
        "stage_id": "string",
        "name": "string",
        "type": "string"
    }
}

Note

Request fails with 409 Conflict if applicant is not currently in the supplied source_stage_id.