Skip to main content
Required scopes: talent_network:read
Rate limit: default tier, 120 requests per minute per key
The ParaAI fast-track opt-in for one candidate — the same setting as the in-app “Fast-track this candidate” toggle, stored per candidate per owning recruiter. When a hiring manager shows interest in a ParaAI match for a fast-tracked candidate, Paraform emails the candidate directly with a link to review the role and self-submit; the owning recruiter is CC’d, notified, and keeps full ownership of the candidate. Without the opt-in only the recruiter is notified. The opt-in is stored, not acted on: nothing happens when it is set. Every precondition is re-checked at the moment a hiring manager shows interest — the recruiter is enabled for fast-track, the candidate is not off market, a contact email is on file, and the recruiter-entered work preferences are complete. If any of those fails at that moment, the recruiter-only flow runs instead. candidateUserId 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. offMarket is true while the candidate is explicitly off market (toggled off or pre-excluded): the opt-in is still stored and returned, but will not fire until they are back on market.

Path parameters

string
required
Constraints: min length 1.

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.