meta data for this page
  •  

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

api:api_applicants_id_emails_id [2018/11/23 15:01] (current)
Lauri Elevant created
Line 1: Line 1:
 +====== /​api/​applicants/​ID/​emails/​ID ======
  
 +===== HEAD, GET =====
 +
 +Get information about an email that has been sent to the applicant.
 +
 +Note that you can also see when the email was delivered and when it was opened (this may not be accurate). If the email is still being delivered, the timestamp contains a NULL.
 +
 +==== Syntax ====
 +
 +  GET /​api/​applicants/​123/​emails/​321
 +  Host: apply.example.edu
 +  Authorization:​ DREAM apikey="​..."​
 +
 +==== Response headers ====
 +
 +  Content-Type:​ application/​json
 +  Content-Length:​ 1456
 +
 +==== Example response ====
 +
 +  {
 +     "​inserted":​ "​2014-06-29T18:​11:​15+00:​00",​
 +     "​delivered":​ "​2014-06-29T18:​11:​15+00:​00",​
 +     "​failed":​ NULL,
 +     "​opened":​ "​2014-06-30T10:​15:​49+00:​00",​
 +     "​from":​ {
 +         "​email":​ "​[email protected]",​
 +         "​name":​ "​Admission Office"​
 +     },
 +     "​subject":​ "Hello world!",​
 +     "​message":​ "Hi there!",​
 +     "​attachments":​ "/​api/​applicants/​1/​emails/​123/​attachments"​
 +  }