Applications

Move an application to another phase

Discover phase IDs with GET /api/v0/processes/{process_id}/phases. For phases with kind: "discarded", discover valid discard_reason values with GET /api/v0/applications/discard_reasons and send one returned id. Moving back to a non-discarded phase clears the stored discard reason.

patch/api/v0/applications/{application_id}/phase

Request

Path parameters

application_idinteger required

Application ID from GET /api/v0/applications.

Headers

Authorizationstring

Bearer credential for the authentication scheme required by this endpoint.

Request body

phase_idinteger required

Target phase ID from GET /api/v0/processes/{process_id}/phases.

positioninteger

Optional target card position within the target phase.

expandstring[]
discard_reasonstring

Required only when the target phase has kind: "discarded"; use an id from GET /api/v0/applications/discard_reasons.

Response

Moves one application through a hiring process and manages discard reasons for rejected phases. Use GET /api/v0/processes/{process_id}/phases to discover valid phase IDs. When the target phase has kind: "discarded", first call GET /api/v0/applications/discard_reasons and send one returned id as discard_reason; moving back to a non-discarded phase clears the stored reason.

Changes

No recorded changes to this operation across all 1 revision of this API.