Send an evaluation link

Sends an external evaluation link to the candidate (SMS and email) and moves the application to the pending_evaluation stage. The link is resolved from the request body, the job’s configured evaluation type, or the job’s legacy evaluation link, in that order.

Authentication

AuthorizationBearer

Supabase-issued user JWT. Send as Authorization Bearer header. Dedicated API keys are planned for a future release.

Path parameters

candidateIdstringRequiredformat: "uuid"

Request

This endpoint expects an object.
applicationIdstringRequiredformat: "uuid"
smsBodystringOptional
emailSubjectstringOptional
emailBodystringOptional
overrideReasonstringOptional

Required to send from a stage that would normally be rejected (e.g. failed_screening). Recorded in the stage history audit trail.

Response

Result of the send action.
successbooleanOptional
stageChangeobjectOptional
smsSentbooleanOptional
emailSentbooleanOptional

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error