API documentation
- Introduction
- DELDelete multiple Candidates.
- GETRetrieve a single Candidate.
- DELDeletes a single Candidate.
- POSTAcknowledge Red Flag.
- GETGet a candidates activities.
- GETGet a candidate's most recent activity.
- POSTExport to Deputy.
- POSTExport candidate to foundU.
- GETGet a candidates interviews.
- GETGet a candidates jobs.
- GETGet info about Candidate:Job Relationship.
- POSTReject Candidate from Job.
- PUTUpdate Candidate Rating for a Job.
- GETVerifiy if Rejection Email has been sent for specific Job.
- PUTLink Single Candidate to Job.
- GETGet a contacts meetings.
- GETGet a candidates messages.
- PUTUpdate Optout flag for a Candidate.
- POSTSend Candidate to Outsourcing Wizard.
- GETGet a candidates placements.
- POSTRed Flag Candidate.
- POSTPerform Reference Check.
- DELRemove Candidate profile picture
- POSTRed Flag Candidate.
- GETDownload Candidate Resume.
- GETDownload Candidate Resume Preview.
- PUTUpdate Candidate Rating for a Saved Search.
- GETGet a candidates submissions.
- PUTUpdate Candidate.
- GETRetrieve a Candidate's Work History.
- POSTCreate a Candidate Work History Entry.
- GETRetrieve a Candidate's Work History.
- PUTUpdate a Candidate Work History Entry.
- DELDelete Candidate Work History Entry.
- GETGet Candidate Attendee Data.
- PUTDownload Resumes.
- POSTExport Candidate to Deputy.
- POSTExport Candidate to foundU.
- POSTReject Candidate List from Job.
- PUTPut apicandidatesjobs updaterating
- POSTVerifiy if Rejection Email has been sent for specific Job and Candidate List.
- PUTLink Bulk Candidates to a Job.
- GETCandidates lookup.
- POSTMerge Candidates.
- GETGet Partner Actions for Candidates.
- GETGet Workflow Partner Actions for Candidates.
- GETCandidates Query.
- PUTUpdate Auto Run Frequency for a Saved Search.
- PUTBulk Update Candidate Rating for a Saved Search.
- POSTPerform Screening.
- GETDownload Screening as Pdf.
- POSTSearch Candidates
- POSTSave Search
- PUTUpdate saved search.
- GETGet Candidates with a particular Tag.
- GETGet Recently Uploaded Candidates.
- GETGet Recently Uploaded Candidates.
- POSTCreate Candidate.
- DEL
Update Optout flag for a Candidate.
Copy
curl --request PUT \
--url https://api.example.com/api/Candidates/{candidateId}/opt-outCandidates
Update Optout flag for a Candidate.
PUT
/
api
/
Candidates
/
{candidateId}
/
opt-out
Update Optout flag for a Candidate.
Copy
curl --request PUT \
--url https://api.example.com/api/Candidates/{candidateId}/opt-outPath Parameters
Response
200
OK
Was this page helpful?
⌘I