Attachment
API version
Select a version to change the base URI
in syntax and code examples. Learn about versions:
in syntax and code examples. Learn about versions
Represents a single attachment to an email sent to an applicant.
URI
/api/v9/applicants/ID/emails/ID/attachments/IDGET Download an email attachment
Download a specific attachment.
Syntax
GET /api/v9/applicants/123/emails/1/attachments/1
Host: apply.example.edu
Authorization: DREAM apikey="..."Example request
Request
curl
curl \
-X GET \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
"https://apply.example.edu/api/v9/applicants/123/emails/321/attachments/1"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/octet-stream | Media type of the resource |
Response codes
| Response code | Description |
|---|---|
200 OK | The email attachment data was successfully returned |
404 Not Found | The email has no attachments |