Skip to content

Using the Restful MAIL API

WillieCJensen edited this page Jan 26, 2017 · 14 revisions

#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: This is left blank in this case.

  {
      "link": "google.com",
      "tempPass": "asdfasdf",
      "type": "candidateNeedsQuiz",
      "assessmentId": ""
  }
  • This is used to send both the candidate and the recruiter an E-Mail that the candidate did NOT take their quiz in the time allowed. You will need to provide a blank link, blank tempPass, a blank assessmentId, and a "type". For this situation the type will be "candidateNotCompleted". An example of a JSON for this situation would be as follows:

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: This is left blank in this case. EXAMPLE candidateNotCompleted: } "link": "", "tempPass": "", "type": "candidateNotCompleted", "assessmentId": "" }

  • This is used to send the recruiter an E-Mail of the grade when a candidate finishes their quiz. You will need to provide a blank link, blank tempPass, and an assessmentId, and a "type". For this situation the type will be candidateCompleted. An example of a JSON for this situation would be as follows:

    { "link": "", "tempPass": "", "type": "candidateCompleted", "assessmentId": "3" }

Clone this wiki locally