;

Reattempt Test

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.

POST https://apiv3.interviewmocha.com/v3/invitations/{testInvitationId}/reattempt
  • Docs
  • Try it
Request URL Parameters
Field Type Required Default Description
testInvitationId Integer64 Yes - Unique identifier given to each test attempt
Request Body Parameters
Field Type Required Default Description
StartDateTime String Yes - Start datetime in UTC ISO 8601 Format
Example: "2020-06-11T16:00:00Z" Format: YYYY-MM-ddTHH:mm:ssZ
EndDateTime String Yes - End datetime in UTC ISO 8601 Format
Example: "2020-06-20T16:00:00Z" Format: YYYY-MM-ddTHH:mm:ssZ
TimeZoneId Integer Yes - Timezone id in which invitation will be accessed.
CallbackUrl String No - Receive candidate test completion notification at your mentioned endpoint
RedirectUrl String No - Redirect candidate to given URL after test completion
Example API endpoint

URL 1: /v3/invitations/2932950/reattempt

Sample Request Body
Request Body
{ "StartDateTime":"2020-07-08T16:00:00Z", "EndDateTime":"2020-07-20T16:00:00Z", "TimeZoneId":"1720", "CallbackUrl":"https://www.interviewmocha.com/", "redirectURL":"https://www.interviewmocha.com/" }
Successful response

Status 200 OK

Response
{ "testInvitationId": 2927076, "testUrl": "https://test.interviewmocha.com/IMInstructions?N0d3bWp0dzFNMytWVFlUTVdZa2lhVzR1bG1PdHFvcGFZVG5ZQmR1N2twcz0", "callbackUrlRegistered": "", "redirectUrlRegistered": "" }
Failed response

Status 400 Bad request

If the state of invitation is invalid

Response
{ "statusCode": 400, "message": "Reattempt is not allowed on Test invitation id which is in pending, inprogress, expired or cancelled state" }
Parameter Value Description Parameter Type Data Type
testInvitationId Unique identifier given to each test attempt Query Integer64
StartDateTime Start datetime in UTC ISO 8601 Format
Example: "2020-06-11T16:00:00Z" Format: YYYY-MM-ddTHH:mm:ssZ
Body String
EndDateTime End datetime in UTC ISO 8601 Format
Example: "2020-06-20T16:00:00Z" Format: YYYY-MM-ddTHH:mm:ssZ
Body String
TimeZoneId Timezone id in which invitation will be accessed. Body Int32
CallbackUrl Receive candidate test completion notification at your mentioned endpoint Body String
RedirectUrl Redirect candidate to given URL after test completion Body String
  • Response Body