Invite candidate by test link
POST
/v3/tests/{testId}/testlinks/{testLinkId}/invite
Inviting a candidate using a test link will copy settings from the given test link and apply them to the invitation. This is useful if you want to keep the same settings for each invite or segregate invites—for example, for campus recruitment or remote assessments.
By default, the API does not send an email to the candidate.
Each test link behaves in an isolated fashion when inviting the same candidate across different test links of the same test. The same candidate (identified by email address) can be invited through different test links for the same test.
| Original Invitation Status | Invite API Behavior |
|---|---|
| Invitation Pending (Test Attempt not taken) | API returns the pending invitation and replaces Access time and timezone ID with new details from the request. |
| Invitation Cancelled | API returns the pending invitation, updates Access time and timezone ID, and changes status to Pending. |
| Invitation Expired | API returns the pending invitation, updates Access time and timezone ID, and changes status to Pending. |
| Test Status - Complete | API returns the same invitation. If the candidate attempts the test, they see: “You have already appeared for the test. Please contact test administrator for further assistance.” |
| Test Status - In Progress | API returns the current invitation where the test is in progress. |
| Test Status - Test Left | API returns the same invitation. If the candidate attempts the test, they see: “You have already appeared for the test. Please contact test administrator for further assistance.” |
Request
Path Params
Header Params
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://apiv3.imocha.io/v3/tests/{testId}/testlinks/{testLinkId}/invite' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
"email": "string",
"name": "string",
"callbackUrl": "string",
"redirectUrl": "string",
"disableMandatoryFields": 0,
"hideInstruction": 0,
"sendEmail": "string"
}'Response Response Example
{
"testInvitationId": 3178622,
"testUrl": "https://test.imocha.io/IMInstructions?eVdzZUlmaHBKK1crRU53dmdEWmM3UzFhQmhWTXFZSk5GZUdhc1RlSDdqQT0m",
"status": "Pending"
}Modified at 2025-08-19 13:32:10