Talent network
Set a candidate's ParaAI fast-track opt-in
curl -X PUT "https://external-api.paraform.com/api/external/v1/talent-network/candidates/$CANDIDATE_USER_ID/fast-track" \
-H "Authorization: Bearer $PARAFORM_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"fastTrack": true
}'
{
"candidateUserId": "string",
"fastTrack": true,
"offMarket": true
}
Required scopes:
Rate limit:
talent_network:writeRate limit:
write tier, 60 requests per minute per keycandidateUserId is the handle returned by the membership list, lookup, and batch items. Any candidate owned by an approved member of your agency is readable; another agency’s id answers 404, indistinguishable from a nonexistent candidate. Both verbs answer 403 when fast-track is not enabled for the candidate’s owning recruiter, and the write additionally requires the candidate to be owned by the recruiter who created the API key.
Sets the opt-in and echoes the persisted state, matching a subsequent GET. The write is accepted while the candidate is off market — the in-app setting persists the same way while its toggle is hidden — and offMarket: true in the response tells you it will not fire until they are back on market. Retries converge on the same state, so no Idempotency-Key is needed.
The write is bound to the recruiter who created the API key: only candidates owned by that recruiter can be set, and any other candidate in the agency answers 403 — agency owners included. To change another recruiter’s candidates, use a key that recruiter created at /agency/api-keys. Reads are not restricted this way.
Path parameters
string
required
Constraints: min length 1.
Body
boolean
required
Response
string
required
boolean
required
boolean
required
True while the candidate is explicitly off market (toggled off by a recruiter, or pre-excluded). Fast-track never fires while true; the opt-in itself is still stored.
curl -X PUT "https://external-api.paraform.com/api/external/v1/talent-network/candidates/$CANDIDATE_USER_ID/fast-track" \
-H "Authorization: Bearer $PARAFORM_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"fastTrack": true
}'
{
"candidateUserId": "string",
"fastTrack": true,
"offMarket": true
}
⌘I
curl -X PUT "https://external-api.paraform.com/api/external/v1/talent-network/candidates/$CANDIDATE_USER_ID/fast-track" \
-H "Authorization: Bearer $PARAFORM_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"fastTrack": true
}'
{
"candidateUserId": "string",
"fastTrack": true,
"offMarket": true
}