Repository navigation

Using the Restful MAIL API

Jump to bottom

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": ""
- 1. 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 link, tempPass, a blank assessmentId, and a "type". For this situation the type will be canidateNotCompleted. An example of a JSON for this situation would be as follows:
  "link": "", "tempPass": "", "type": "canidateNotCompleted", "assessmentId": ""
- 1. This is used to send the recruiter an E-Mail that their candidate has completed their quiz and the grade they received. You will need to provide a link, tempPass, a blank 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": ""

Created by the worst doctor - Weston Wright, M.D.

In partner with Magic Mike and SideCarWillie, updated by KarthikSR