Notes
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 list of notes added to an applicant.
URI
/api/v10/applicants/ID/notesThe PUT /api/applicants/ID/notes request was discontinued starting from version 6. To create a new note, use the POST method instead. For backwards compatibility, the PATCH method is supported, but is deprecated.
GET List notes
List all notes — text messages (sticky notes) added to the applicant card.
Syntax
GET /api/v10/applicants/123/notes
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/applicants/123/notes"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 list of notes was successfully returned |
Example response
Response
curl
{
"1": {
"created": "2026-06-05T06:18:27+00:00",
"removed": null,
"colour": "Yellow",
"pinned": false,
"collapsed": false,
"Notes": "Some comments"
},
"2": {
"created": "2026-05-10T13:18:26+00:",
"removed": null,
"colour": "Salmon",
"pinned": true,
"collapsed": false,
"Notes": "Some more comments"
},
"3": {
"created": "2026-03-05T06:19:10+00:00",
"removed": "2026-03-05T06:19:17+00:00",
"colour": "Blue",
"pinned": false,
"collapsed": false,
"Notes": "Removed comments"
}
}Response
curl
"Some comments -- Some more comments"POST Add a note
Create a new note for an applicant.
Syntax
POST /api/v10/applicants/123/notes
Host: apply.example.edu
Authorization: DREAM apikey="..."Parameters
| Name | Required/Optional | Description | Notes |
|---|---|---|---|
colour | Optional | The colour of the sticky note. Allowed values: Yellow, Orange, Salmon, Green, Blue, Violet. | - |
color | Optional | An alias for colour. | If both colour and color values are specified, the colour value is preferred. |
Raw request body
The request body must contain a valid JSON string literal that meets the following requirements:
- The value must be enclosed in double quotes, for example,
"Some note", notSome note. - According to the JSON specification, only spaces are allowed. Other characters, such as new lines (
\n) and quotation marks (\"), must be encoded.
Request body
"The first line in the note\nThe second line in the note"Example request
Request
curl
curl \
-X POST \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
-d '"The first line in the note\nThe second line in the note"' \
"https://apply.example.edu/api/v10/applicants/123/notes"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 codes
| Response code | Description |
|---|---|
204 No Content | The notes were successfully saved |
400 Bad Request | Invalid notes, please make sure that status is a valid JSON string with quotes |