Offer to assist candidates

Request

Allows candidate service providers to offer assistance to one or more candidates. For example, to invite eligible candidate's to access specialised services for education, migration or settlement support.

Security

ApiKeyAuth

Bodyapplication/jsonrequired

Information about the prospective employer, recruiter or candidate service provider expressing interest in the candidate

candidatesArray of objects(CandidateCoupon)

A list of candidate public IDs and optional coupon codes.

reasonstring(candidate_assistance_type)

The reason for expressing interest in the candidate

Enum:"JOB_OPPORTUNITY""EDUCATION_SERVICE""MIGRATION_SERVICE""FINANCIAL_SUPPORT_SERVICE""SETTLEMENT_SERVICE""OTHER"

Example:"EDUCATION_SERVICE"

additionalNotesstring

Optional additional notes provided by the candidate service provider

Example:"We would like to provide our services to these candidates."

curl -i -X POST \
  https://tc-api.redocly.app/_mock/openapi/v1/candidates/offer-to-assist \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "candidates": [
      {
        "publicId": "ABcd2EFgHIjkLMNOp3QR-S",
        "couponCode": "COUPON2025"
      }
    ],
    "reason": "EDUCATION_SERVICE",
    "additionalNotes": "We would like to provide our services to these candidates."
  }'

Responses

Successfully expressed interest in the candidate

Bodyapplication/json

messagestring

Success message

Example:"Your offer has been successfully recorded."

offerIdstring

The unique ID for the offer to assist record

Example:"interest-7890"

Response

{
  "message": "Your offer has been successfully recorded.",
  "offerId": "interest-7890"
}