/company/{id}/position/{id}/candidates/stage

Moves up to 50 candidates on a position to one pipeline stage in one request, and reports what happened to each one. Each move is the same as PUT /candidate/{candidateId}/stage: the stage's actions, activity and webhooks are the same.

With dry_run: true nothing is changed. The response says who would move and which of the stage's actions would run for whom, so a person can confirm a move before it sends messages to candidates.

Candidates already in the stage are skipped and listed in already_in_stage. A candidate the caller can't see (in a restricted stage, or private) is listed in denied with the reason, and ids that aren't on the position are listed in not_found.

actions describes what the stage does when a candidate enters it: messages (each template, and how long after the move it is sent), candidate_facing (other actions that reach the candidate, such as a questionnaire or background check), team (actions for the hiring team, such as tags or tasks) and hris (systems the candidate is added to as an employee). Stage actions run the first time a candidate enters a stage, so runs_for lists the candidates they will run for; a candidate who has been in the stage before is moved without them.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
string
required
Body Params
candidate_ids
array of strings
required
length between 1 and 50

1 to 50 candidate ids on this position.

candidate_ids*
string
required

The stage to move them to. Use the stage id values from GET /company/{companyId}/pipeline/{pipelineId}.

boolean
Defaults to false

Report what the move would do without changing anything.

Responses

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