Offer subject
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 the subject line of an application offer.
URI
/api/v10/applications/ID/offers/ID/subjectGET Get the offer subject
Retrieve the subject line of an offer letter.
Syntax
GET /api/v10/applications/123/offers/321/subject
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/v10/applications/123/offers/321/subject"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json | The media type of the resource |
Content-Length | 1234 | The size of the response body in bytes |
Response codes
| Response code | Description |
|---|---|
200 OK | The offer letter subject line was successfully returned |
404 Not Found | The application does not have this offer |
Example response
Response
"You are accepted to a study place"PUT Set the offer subject
Set the subject line for an offer letter.
Syntax
PUT /api/v10/applications/123/offers/321/subject
Host: apply.example.edu
Authorization: DREAM apikey="..."Raw request body
The request body must contain a valid JSON string literal enclosed in double quotes. Upon successful validation, the provided text is saved as the subject line for the application offer.
Request body
"Congratulations, you are accepted"Example request
Request
curl
curl \
-X PUT \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
-d '"Congratulations, you are accepted"' \
"https://apply.example.edu/api/v10/applications/123/offers/321/subject"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | text/plain | The media type of the resource |
Content-Length | 0 | The size of the response body in bytes |
| Response code | Description |
|---|---|
200 OK | The subject was successfully set |
400 Bad Request | An invalid offer subject line |
404 Not Found | The application does not have this offer |