Differences

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

--- api:api_applicants_id_emails [2018/11/23 14:59] – created Lauri
+++ api:api_applicants_id_emails [2024/07/30 11:50] (current) – external edit 127.0.0.1
@@ Line 48: / Line 48: @@
     }
   }
+===== 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 |