API Reference

/candidates/:id/relocate

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

Log in to see full request history

❗️

Copy vs Relocate

The only difference between these two endpoints is that the Copy method preserves the source candidate while the Relocate method deletes it.

📘

Want to retrieve the created candidate?

This endpoint creates a new candidate on the specified job and stage. To get the new candidate follow the URL from the body of the response.

A complete request would be

{ "member_id": "13e0eb0e", "target_job_shortcode": "GROOV005", "target_stage": "applied" }
Path Params
string
required

The candidate's id

Body Params
string
required

The member perfoming the relocation

string
required

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

string

The stage the candidate should be moved to

Responses

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