Recruiter

Add or move a Recruiter candidate

Put one person into a hiring project's pipeline, or move them to another stage.

The published definition calls the person's id only "the ID of the user"; that it is the Recruiter id is this tool's own wording.

Docs: https://heyreagent.com/docs/actions/move_recruiter_candidate

post/v1/actions/move_recruiter_candidate

Request

  • Base URL: https://api.heyreagent.com
  • URL: https://api.heyreagent.com/v1/actions/move_recruiter_candidate
  • Auth: HTTP bearer

Request body

candidateIdstring required

The person's Recruiter id (AE…).

action'add_candidate' | 'add_applicant' | 'change_stage' required

add_candidate: add someone you sourced. add_applicant: add someone who applied. change_stage: move someone already in the pipeline.

hiringProjectIdstring required

The hiring project (from list_hiring_projects).

stage'UNCONTACTED' | 'CONTACTED' | 'REPLIED'

The pipeline stage (default UNCONTACTED).

connectionIdstring

Which of your LinkedIn accounts to act from (its id from list_linkedin_accounts). Omit to use your first live one.

Response

It worked. Inside result: done, candidateId, action, hiringProjectId, from, usedToday, dailyLimit.

oktrue required
resultobject required

What was asked for. A field that does not apply is left out, or is null.

Changes

No recorded changes to this operation across all 1 revision of this API.