Expression of interest in candidates for a job

Request

Allows prospective employers or recruiters to indicate that one or more candidates look like they match the requirements of a job, and that they are interested in proceeding further with those candidates.

Security

ApiKeyAuth

Bodyapplication/jsonrequired

Information about the prospective employer or recruiter who has the job

candidatesArray of objects

A list of candidate public IDs.

additionalNotesstring

Optional additional notes provided by the employer or recruiter

Example:"Candidates' experience aligns with our job requirements. We would like to arrange interviews at the earliest convenience."

curl -i -X POST \
  https://tc-api.redocly.app/_mock/openapi/v1/candidates/job-match \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "candidates": [
      {
        "publicId": "ABcd2EFgHIjkLMNOp3QR-S"
      }
    ],
    "additionalNotes": "Candidates'\'' experience aligns with our job requirements. We would like to arrange interviews at the earliest convenience."
  }'

Responses

Successfully expressed interest in matching the candidates to the job

Bodyapplication/json

messagestring

Success message

Example:"Your interest has been successfully recorded."

jobMatchIdstring

The unique ID for the job match record

Example:"job-match-7890"

Response

{
  "message": "Your interest has been successfully recorded.",
  "jobMatchId": "job-match-7890"
}