API Reference
Log In
API Reference
These docs are for v2.0. Click to read the latest docs for v2.1.

Advance an Applicant

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This method moves an applicant to an appropriate stage if specified or to the next stage by default.

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
Defaults to 22222222-0000-0000-0000-000000000000

An applicant's UUID

Query Params
string
Defaults to dc1fe619-2842-4a32-a2b5-0a6c53bfd7e2

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

Body Params
boolean
Defaults to false

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

Headers
string
required
Defaults to secret-api-token

Access Token

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json