Docs / Recruiter
move_recruiter_candidate
Put one person into a hiring project's pipeline, or move them to another stage.
This action can change or spend something, and when it does it happens right away. Read “Good to know” first.
What you give it
| Input | What it is | Where to get it |
|---|---|---|
candidateIdneeded | A Recruiter id. The person's Recruiter id (AE…). | Run search_linkedin_recruiter_people and use results[].id from its answer. |
actionneeded | One of: add_candidate, add_applicant, change_stage. add_candidate: add someone you sourced. add_applicant: add someone who applied. change_stage: move someone already in the pipeline. | You write it. |
hiringProjectIdneeded | A hiring project id. The hiring project (from list_hiring_projects). | Run list_hiring_projects and use projects[].id from its answer.2 more places to get it
|
stageoptional | One of: UNCONTACTED, CONTACTED, REPLIED. The pipeline stage (default UNCONTACTED). | You write it. |
connectionIdoptional | A connection id. Which of your LinkedIn accounts to act from (its id from list_linkedin_accounts). Omit to use your first live one. | Run list_linkedin_accounts and use accounts[].id from its answer.15 more places to get it
|
Call it
curl -X POST https://api.heyreagent.com/v1/actions/move_recruiter_candidate \
-H "Authorization: Bearer YOUR_KEY" \
-H "content-type: application/json" \
-d '{"candidateId":"PASTE_RECRUITER_ID_HERE","action":"add_candidate","hiringProjectId":"PASTE_HIRING_PROJECT_ID_HERE"}'The same call in JavaScript
const response = await fetch("https://api.heyreagent.com/v1/actions/move_recruiter_candidate", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_KEY",
"content-type": "application/json",
},
body: JSON.stringify({
"candidateId": "PASTE_RECRUITER_ID_HERE",
"action": "add_candidate",
"hiringProjectId": "PASTE_HIRING_PROJECT_ID_HERE"
}),
});
const answer = await response.json();
console.log(answer);The same call in Python
import requests
response = requests.post(
"https://api.heyreagent.com/v1/actions/move_recruiter_candidate",
headers={"Authorization": "Bearer YOUR_KEY"},
json={
"candidateId": "PASTE_RECRUITER_ID_HERE",
"action": "add_candidate",
"hiringProjectId": "PASTE_HIRING_PROJECT_ID_HERE",
},
)
print(response.json())The same call in n8n
Add an HTTP Request node and fill it in like this:
| Method | POST |
| URL | https://api.heyreagent.com/v1/actions/move_recruiter_candidate |
| Send Headers | On. Name Authorization, Value Bearer YOUR_KEY |
| Send Body | On. Body Content Type JSON, Specify Body Using JSON, then paste the body below |
{
"candidateId": "PASTE_RECRUITER_ID_HERE",
"action": "add_candidate",
"hiringProjectId": "PASTE_HIRING_PROJECT_ID_HERE"
}Put your own key where it says YOUR_KEY. Put your own value where it says PASTE_…_HERE: the table above says where each one comes from. New here? Start with your first call.
What you get back
When it worked, the answer is { "ok": true, "result": { … } }. Inside result:
done | |
candidateId | |
action | |
hiringProjectId | |
from | the account it ran on |
usedToday | number |
dailyLimit | number |
A field that does not apply to an answer is left out, or is null.
When it did not work, the answer is { "ok": false, "error": "…", "message": "…" }. What each error means.
Good to know
- 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.
In Claude or ChatGPT
Once connected, ask in your own words. The assistant sees this action as a tool with the same name, move_recruiter_candidate, and the same inputs.