/candidates/:id/relocate

Moves a candidate to another job. Required scope: w_candidates. Accessible with all token types.

post/candidates/{id}/relocate

Request

  • Base URL
    https://subdomain.workable.com/spi/v3
  • URL
    https://subdomain.workable.com/spi/v3/candidates/{id}/relocate
  • Auth
    API key in header Authorization

Path parameters

idstring required

The candidate's id

Request body

member_idstring required

The member perfoming the relocation

target_job_shortcodestring required

The shortcode of the job that the candidate will be moved to

target_stagestring

The stage the candidate should be moved to

Response

201

Example response

{
  "candidate": {
    "id": "3fc9a80f",
    "url": "https://groove-tech.workable.com/spi/v3/candidates/3fc9a80f"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.