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.
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 |
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.interviewmocha.com/", "redirectURL":"https://www.interviewmocha.com/", "disableMandatoryFields":0, "hideInstruction":0 }
Status 201 Created
Response{ "testInvitationId": 2807324, "testUrl":"https://test.interviewmocha.com/IMInstructions?bk1kdWNyYXdudzN" }
Status 400 Bad Request
If required parameters have invalid values.
Response{ "errors": [ "'Email' must not be empty.", "Email address is in invalid format" ] }