Talent network
Take candidates off the ParaAI market
curl -X POST "https://external-api.paraform.com/api/external/v1/talent-network/candidates/off-market" \
-H "Authorization: Bearer $PARAFORM_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"candidates": [
{
"candidateUserId": "string"
}
]
}'
{
"results": [
{
"index": 0,
"ok": true,
"status": "off_market"
}
]
}
Required scopes:
Rate limit:
talent_network:writeRate limit:
write tier, 60 requests per minute per keycandidateUserId (from GET /talent-network/candidates or POST /talent-network/candidates/lookup), or by email / linkedinUrl. candidateUserId wins when both are given; otherwise linkedinUrl beats email, the same precedence lookup documents. An identity reference acts on every membership row your agency holds for that person, so a candidate two of your recruiters own goes off market for both — candidateUserIds lists every row acted on.
results is index-aligned with candidates; a well-formed request always answers 200, so branch on per-item ok. status values: off_market (was on market, now off), already_off_market (nothing to change — includes locked candidates, which stay off market), pre_excluded (the candidate was never in the talent network and is now excluded from future consideration; only a fresh submit — not /re-enable — restores them), and not_found (no candidate owned by an approved member of your agency matches this reference, indistinguishable from a candidate that does not exist). Statuses are never renamed but new ones may be added — branch on ok and treat an unknown status as informational.
Requires Talent Network management to be enabled for your agency; without it the whole request answers 403 (re-enabling never requires it). Retries converge on already_off_market, so no Idempotency-Key is needed. Duplicate references in one request collapse to a single action and report the same result at every index.
Body
object[]
required
Response
object[]
required
curl -X POST "https://external-api.paraform.com/api/external/v1/talent-network/candidates/off-market" \
-H "Authorization: Bearer $PARAFORM_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"candidates": [
{
"candidateUserId": "string"
}
]
}'
{
"results": [
{
"index": 0,
"ok": true,
"status": "off_market"
}
]
}
⌘I
curl -X POST "https://external-api.paraform.com/api/external/v1/talent-network/candidates/off-market" \
-H "Authorization: Bearer $PARAFORM_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"candidates": [
{
"candidateUserId": "string"
}
]
}'
{
"results": [
{
"index": 0,
"ok": true,
"status": "off_market"
}
]
}