FOfountain
Applicants

Advance an Applicant

Changed on

Advance an applicant in an opening

put/v2/applicants/{id}/advance

Request

  • Base URL
    https://api.fountain.com
  • URL
    https://api.fountain.com/v2/applicants/{id}/advance
  • Auth
    API key in header X-ACCESS-TOKEN

Path parameters

idstring required

The applicant's external ID

Headers

Idempotency-Keystring

A unique key for this move, at most 255 characters. A request whose key already moved this applicant answers 204 without moving it again. Send the same key when you retry after an error or a timeout.

Request body

stage_idstring

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

from_stage_idstring

The external id of the stage the applicant must be on. If the applicant is on another stage, nothing moves and the response is 409 with current_stage_id. Send it so a retry after an error or a timeout cannot move the applicant twice.

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

Changes

  • 3119e105004cRevision changes
    • info

      api tag exposeAsMcpTool removed

    • info

      added the new optional header request parameter Idempotency-Key

    • info

      added the new optional request property

    • info

      added the non-success response with the status