/candidates/:id/move

post

https://{subdomain}.workable.com/spi/v3/candidates/{id}/move

Moves the candidate to another stage. Required scope: w_candidates. Accessible with all token types.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The candidate's id

Body Params

member_id

string

required

The member perfoming the move

target_stage

string

The stage the candidate should be moved to

fill_reserved_requisition

boolean

Defaults to false

When the candidate has a reserved requisition, set this to true to use that requisition. If the requisition has already a start date and the salary information (amount, frequency and currency) you don't need any additional parameters. If there is missing information, you can use the requisition key to provide it.

requisition

object

In case the candidate doesn't have a reserved requisition, you can select an open, approved or on-hold requisition. You can use this object to specify which requisition to fill, and set some of its properties. You can also use this key to provide missing information from the reserved requisition.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Header

URL

Loading…

Response

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

text/plain

application/json

202202

401401

404404