API will create "Default test link" in system for given test (if not present already), and all future invites (using this API) will apply configuration from default link.
By default, API does not send email to candidate.
This API is handy (kind of shortcut) in case you do not want retrieve test link every single time just to send invites to candidate. If you wish to use specific test link to invite, check "Invite candidate by test link" API.
| Original Invitation Status | Invite API Behavior |
|---|---|
| Invitation Pending (Test Attempt not taken) | Invite 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 Cancelled | Invite 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 Expired | Invite 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- Complete | The Invite API does not throw an error; instead, it returns the same invitation. However, if the candidate tries to retake the test, the platform will display a message stating: 'You have already attempted this test.' If you wish to allow the candidate to retake the same test, please use our Reattempt API. |
| Test Status- In Progress | Invite API doesn't throw an error. It returns the current invitation for which the Test is in Progress |
| Test Status- Test Left | The Invite API does not throw an error; instead, it returns the same invitation. However, if the candidate tries to retake the test, the platform will display a message stating: 'You have already attempted this test.' If you wish to allow the candidate to retake the same test, please use our Reattempt API. |
Each test invitation has its own stakeholder email field, therefore for every API call must be called with above field & correct value must be sent order to work as intended.
This will override stakeholder email for each individual invite. Not including this field will take value that is present in “Default test link”.
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| testId | Integer64 | Yes | - | Unique identifier of the test |
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| String | Yes | - | Email address of candidate | |
| name | String | Yes | - | Full name of candidate |
| callbackUrl | String | No | - | Receive candidate test completion notification at your mentioned endpoint. Callback object can be found here |
| redirectUrl | String | No | - | Redirect candidate to given URL after test completion |
| disableMandatoryFields | Integer | No | 0 | When enabled, email and name fields not required. System auto generates random values both fields. |
| hideInstruction | Integer | No | 0 | Skips test instruction page |
| sendEmail | String | No | no | When enabled sends test invitation email to candidate.By default disabled. Possible values yes or no |
| stakeholderEmails | String | No | Default Test link stakeholder email/ Owner of test email id |
Comma separated list of emails used to send stakeholders email after candidate test completion if you want to disable emails to stakeholderEmails use stakeholderEmails field value disable |
| startDateTime | String | No | Default Test link settings | Start datetime in UTC ISO 8601 Format Example: "2020-06-11T16:00:00Z" Format: YYYY-MM-ddTHH:mm:ssZ |
| endDateTime | String | No | Default Test link settings | End datetime in UTC ISO 8601 Format Example: "2020-06-20T16:00:00Z" Format: YYYY-MM-ddTHH:mm:ssZ |
| timeZoneId | Integer | No | Default Test link settings | Timezone id in which invitation will be accessed. |
| ProctoringMode | String | No | disabled | Supported mode - disabled, image, video |
| Field | Type | Description |
|---|---|---|
| testInvitationId | Integer64 | Unique identifier given to each test attempt |
| testUrl | String | URL which candidate can access to appear for the test |
URL 1: /v3/tests/292930/invite
Request Body{ "email":"[email protected]", "name":"amey", "callbackURL":"https://www.imocha.io/", "redirectURL":"https://www.imocha.io/", "disableMandatoryFields":0, "hideInstruction":0 }
URL 1: /v3/tests/292930/invite
Request Body{ "email":"[email protected]", "name":"amey", "callbackURL":"https://www.imocha.io/", "redirectURL":"https://www.imocha.io/", "disableMandatoryFields":0, "hideInstruction":0, "stakeholderEmails":"disable" }
Status 200 OK
Response{ "testInvitationId": 2807324, "testUrl":"https://test.imocha.io/IMInstructions?bk1kdWNyYXdudzN", "status":"Complete" }
Status 400 Bad Request
If required parameters have invalid values.
Response{ "errors": [ "'Email' must not be empty.", "Email address is in invalid format" ] }