Note
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
Represent a single note added to an applicant.
URI
/api/v10/applicants/ID/notes/IDGET Get a note
Retrieve information about a specific note — a text message (sticky note) added to the applicant card.
Syntax
GET /api/v10/applicants/123/notes/321
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/321"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 note data was successfully returned |
Example response
Response
curl
{
"created": "2026-06-24T08:16:00+00:00",
"removed": null,
"colour": "Yellow",
"pinned": true,
"collapsed": false,
"notes": "The first line in the note\nThe second line in the note"
}PUT Update a note
Update a specific note for an applicant.
Syntax
PUT /api/v10/applicants/123/notes/321
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 PUT \
-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/321"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 note was successfully saved |
400 Bad Request | Invalid notes, please make sure that status is a valid JSON string with quotes |