Repository navigation
Using the Restful MAIL API
#Access the ONE endpoint with a post. ##End Points you can access
- /user/{userEmail}/mail
- userEmail is the candidate's email that you need to send an Email to.
To send a candidate their quiz send a JSON object as follows. Link: the link of the login page for the candidate. tempPass: the temporary password for the candidate. type: candidateNeedsQuiz. assessmentId: Blank.
EXAMPLE candidateNeedsQuiz: { "link": "google.com", "tempPass": "asdfasdf", "type": "candidateNeedsQuiz", "assessmentId": "" }
To send a candidate and their recruiter an email because the candidate didn't take the assessment. Link: Blank. tempPass: Blank. type: candidateNeedsQuiz. assessmentId: Blank.
EXAMPLE candidateNotCompleted: } "link": "", "tempPass": "", "type": "candidateNotCompleted", "assessmentId": "" }
To send a recruiter an email after a candidate has completed their assessment. Link: Blank. tempPass: Blank. type: candidateNeedsQuiz. assessmentId: The assessment ID of the assessment the candidate completed.
EXAMPLE: candidateCompleted { "link": "", "tempPass": "", "type": "candidateCompleted", "assessmentId": "3" }