About iMochaHelpBook a demo
About iMochaHelpBook a demo
  1. Test Invitations
  • Introduction
  • Skills Assessment API
    • API Reference
      • Getting started
      • API Environment
      • Authentication Mechanism
      • Error Code
      • List timezones
    • Test
      • List all tests
      • Retrieve a test
      • Retrieve test settings
      • Update Test Settings
    • Test Invitations
      • Callback notification
      • Invite candidate
        POST
      • Invite candidate by test link
        POST
      • Reattempt Test
        POST
      • Cancel Invitation
        POST
    • Test Link
      • List all test links
    • Report
      • Retrieve candidate test report
      • Retrieve candidate test report in PDF
    • Callback API
      • Process Callbacks
      • Retrieve Invites
    • GDPR
      • GDPR Data Masking Service
    • Users
      • Get all business units
      • Create New User
      • Update User
      • Active/ Inactive User
  • Skills Intelligence API
    • Introduction
    • Authentication
    • Employee
      • List employees
      • Get Employee Skills by employeeId
      • Employee Enrollment
      • Update Employee Status
    • JobProfiles
      • Get All JobProfiles
      • Get JobProfile with Skills By JobProfileId
      • Create JobCode
    • Taxonomy
      • Get all Taxonomy Skills
    • CareerPath
      • Get Employee Career Path by employeeId
    • Account
      • Get Multichannel Validation Weightages
  1. Test Invitations

Reattempt Test

POST
/v3/invitations/{testInvitationId}/reattempt
🔶 Allows candidate to reattempt/retake a test.
API Behavior
By default candidate can only appear for test once, in specific test link. To allow reattempt after initial invite, use this API.
You can allow multiple reattempts after first test attempt. Note, for the first time, use "Invite Candidate" or "Invite Candidate by test link" API to take the test.
Once you allow reattempt, only after completing reattempt, new subsequent reattempt can be made. If you make call to Reattempt API without appearing for the test, API will return latest active reattempt test invitation details again in response if API call is made.
By default, API does not send email to candidate.
Original Invitation StatusReattempt Behavior
Invitation Pending (Test Attempt not taken)Reattempt API doesn't throw an error. It returns back the pending invitation. However it replaces the old Access time and timezoneid with the new details passed in the API request.
Invitation CancelledReattempt API doesn't throw an error. It returns back the pending invitation. However it replaces the old Access time and timezoneid with the new details passed in the API request and changes the Invitation Status to Pending.
Invitation ExpiredReattempt API doesn't throw an error. It returns back the pending invitation. However it replaces the old Access time and timezoneid with the new details passed in the API request and changes the Invitation Status to Pending.
Test Status - CompleteReattempt API sends back a new TestInvitationID and URL. It inherits the test settings of the original testinvitationid except for Access time and timezoneid.
Test Status - In ProgressReattempt API sends a response back "Reattempt is not allowed on Test invitation id: 999999 which is in inprogress state."
Test Status - Test LeftReattempt API sends back a new TestInvitationID and URL. It inherits the test settings of the original testinvitationid except for Access time and timezoneid.

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https://apiv3.imocha.io/v3/invitations/{testInvitationId}/reattempt' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "StartDateTime": "string",
    "EndDateTime": "string",
    "TimeZoneId": 0,
    "CallbackUrl": "string",
    "RedirectUrl": "string",
    "hideInstruction": 0,
    "sendEmail": "string"
}'
Response Response Example
{
    "testInvitationId": 0,
    "testUrl": "string",
    "callbackUrlRegistered": "string",
    "redirectUrlRegistered": "string"
}
Modified at 2025-08-19 13:32:26
Previous
Invite candidate by test link
Next
Cancel Invitation
Built with