Advance an Applicant

put

https://api.fountain.com/v2/applicants/{id}/advance

Advance an applicant in an opening

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

This method moves an applicant to an appropriate stage if specified or to the next stage by default. If stage_id is provided to indicate a specific stage, then it is required to send funnel_id as well.

All automated actions associated with the target stage are invoked by default.

You can skip the automated actions using the skip_automated_actions parameter set to "true".

Path Params

string

required

The applicant's external ID

Body Params

stage_id

string

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

funnel_id

string

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

skip_automated_actions

boolean

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

rejection_reason_id

string

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

archived_reason_id

string

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

validate_data

boolean

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.

Responses

204

No Content

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

401Unauthorized