;

Invite candidate

Registers candidate for given test using "Default test link".
API Behavior

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.

Stakeholder Field

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”.

POST https://apiv3.imocha.io/v3/tests/{testId}/invite
  • Docs
  • Try it
Request URL Parameters
Field Type Required Default Description
testId Integer64 Yes - Unique identifier of the test
Request Body Parameters
Field Type Required Default Description
email 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.
Response
Field Type Description
testInvitationId Integer64 Unique identifier given to each test attempt
testUrl String URL which candidate can access to appear for the test
Example API endpoint

URL 1: /v3/tests/292930/invite

Sample Request Body 
Request Body

                                    
     {
        "email":"[email protected]",
        "name":"amey",
        "callbackURL":"https://www.imocha.io/",
        "redirectURL":"https://www.imocha.io/",
        "disableMandatoryFields":0,
        "hideInstruction":0
     }
Example API endpoint

URL 1: /v3/tests/292930/invite

Sample Request Body ( disable stakeholderEmails) 
Request Body

                                    
     {
        "email":"[email protected]",
        "name":"amey",
        "callbackURL":"https://www.imocha.io/",
        "redirectURL":"https://www.imocha.io/",
        "disableMandatoryFields":0,
        "hideInstruction":0,
        "stakeholderEmails":"disable"
     }
Successful response

Status 200 OK

Response

                        
        {
            "testInvitationId": 2807324,
            "testUrl":"https://test.imocha.io/IMInstructions?bk1kdWNyYXdudzN"
        }
Failed response

Status 400 Bad Request

If required parameters have invalid values.

Response

                                
    {
        "errors": [
            "'Email' must not be empty.",
            "Email address is in invalid format"
        ]
    }
Parameter Value Description Parameter Type Data Type
testId test Id associated with particular test Query Integer64
emailId Email Id of Candidate Body String
fullName Full name of Candidate Body String
callbackURL After completion of test callback object will be send on this URL Body String
redirectURL After completion of test candidate will redirect to this URL Body String
disableMandatoryFields When enabled, email and name fields not required. System auto generates random values for both fields. Body Integer
hideInstruction Skips test instruction page Body Integer
sendEmail When enabled sends test invitation email to candidate.By default disabled Body String
stakeholderEmails 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 		Body String
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
  • Response Body