v1

latestOpenAPI 3.0.12026-07-245752052.0 MB

Applicants

exposeAsMcpTool

Advance an Applicant

Advance an applicant in an opening

put/v2/applicants/{id}/advance

Path parameters

idstring required

The applicant's external ID

Request body

stage_idstring

Destination stage's external id. If not provided, the applicant will advance to the next stage by default.

funnel_idstring

Destination funnel's external id. Required when advancing to a workflow-based stage using stage_id.

skip_automated_actionsboolean

Set true if you want to skip automated actions when advancing the applicant. Defaults to false.

rejection_reason_idstring

The external ID or ID of a rejection reason to apply when advancing the applicant.

archived_reason_idstring

The external ID or ID of an archived reason to apply when advancing the applicant.

validate_databoolean

Set true to validate the applicant's existing data against the target stage's ValidationGroup before advancing. Returns 422 with field-level errors when invalid. Defaults to false.

Response

No Content