Skip to content

Using the Restful MAIL API

Weston Wright edited this page Jan 2, 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 for, never will it be the recruiter. There are currently three situations where an email needs to be sent.

      1. Candidate needs to be sent their quiz. You will need to provide a link, tempPass, a blank assessmentId, and a "type". For this situation the type will be candidiateNeedsQuiz. An example of a JSON for this situation would be as follows:

      "link": "google.com", "tempPass": "asdfasdf", "type": "candidiateNeedsQuiz", "assessmentId": ""
      
      
  • /canidateNOTCompletedEmail

    • 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 need to send the candidates E-Mail, the recruiters E-Mail, the candidates name, AND AN ID of 2. In that order. An example of an acceptable JSON is below. Please provide them in the order shown with the keys shown. Keys-> candidateEmail, recruiterEmail, candidateName, id.

       "candidateEmail": "example@gmail.com"
       "recruiterEmail": "exampleRecuiterEmail@gmail.com"
       "candidateName": "Daniel DropTables"
       "id": "2"
  • /recruiterReturnGradeEmail

    • This is used to send the recruiter an E-Mail that their candidate has completed their quiz and the grade they received. You need to send the recruiters E-Mail, candidates name, and the candidates grade, AND AN ID of 3. In that order. An example of an acceptable JSON is below. Please provide them in the order shown with the keys shown. Keys-> recruiterEmail, candidateName, grade, id.
     "recruiterEmail": "exampleRecuiterEmail@gmail.com"
     "candidateName": "Daniel DropTables"
     "grade": "15"
     "id": "3"

Clone this wiki locally