Table of Contents

/api/applicants/ID/emails

HEAD, GET

Get a list of emails that have been sent to this applicant. Note that this list will only shows emails that have been stored. Any emails containing credentials or other secrets (for example password reminders) are delivered immediately without storing them to the database, an are therefore unavailable here as well.

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
Host: apply.example.edu
Authorization: DREAM apikey="..."

Response headers

Content-Type: application/json
Content-Length: 1456

Example response

{
  "123": {
      "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": "sender@uni.edu",
          "name": "Admission Office"
      },
      "subject": "Hello world!",
      "message": "Hi there!",
      "attachments": "/api/applicants/1/emails/123/attachments"
  },
  "321": {
      "inserted": "2014-07-10T19:21:55+00:00",
      "delivered": NULL,
      "failed": NULL,
      "opened": NULL,
      "from": {
          "email": "sender@uni.edu",
          "name": "Admission Office"
      },
      "subject": "Hello world!",
      "message": "Hi there!",
      "attachments": NULL
  }
}

POST

Create and send a new email to the applicant. Note that after the email is created, it may take a few minutes for it to be delivered. The URI for the email created is returned in the Location header and you can poll this URI after a few minutes to see if it was delivered successfully.

:!: Please note that this feature is not enabled by default. Please contact the support team to be white-listed.

Syntax

POST /api/applicants/123/emails
Host: apply.example.edu
Authorization: DREAM apikey="..."

Parameters

Name Description
subject Required This is the email subject line. 2 to 128 characters.
message Required This is the email message itself in text form. 4 to 4096 characters. Note that you can use basic Textile syntax here like *bold*. The HTML version of the email is generated by DreamApply.

Response headers

Content-Type: application/json
Content-Length: 0
Location: /api/applicants/123/emails/321

Response codes

201 Created New email was created (does not yet mean it was delivered)
400 Bad Request Some of the email parameters were not correct
403 Forbidden You have not been white-listed to use use this feature