AddNote | DreamClass | Documentation

curl -X POST https://https//https/dreamclassapi/v1/settings/notes \
     -H "tenant: {{tenant}}" \
     -H "schoolCode: {{schoolCode}}" \
     -H "Content-Type: application/json" \
     -d '{
  "user": {
    "id": 23
  },
  "notes": "<p>Sample note</p>",
  "title": "Test Note",
  "pinned": true,
  "reporter": {
    "id": 27
  },
  "semester": {
    "id": 1
  },
  "schoolTags": [
    {
      "id": 23
    }
  ],
  "visibleToAdmins": false,
  "visibleToStudent": true,
  "visibleToTeachers": true,
  "visibleToGuardians": false
}'

{
  "id": 73,
  "notes": "<p>Sample note</p>",
  "title": "Test Note",
  "pinned": true,
  "userId": 23,
  "createat": "2025-08-30T14:11:23.293+00:00",
  "updatedAt": "2025-08-30T14:11:23.293+00:00",
  "reportedId": 27,
  "schoolTags": [
    23
  ],
  "visibleToAdmins": false,
  "visibleToStudent": true,
  "visibleToTeachers": true,
  "visibleToGuardians": false
}

Add a new note

Semester: Check the GetSchoolPeriods call

User/Reporter: Check the GetStudent

School Tags: Check the Tags call

Request

This endpoint expects an object.

userobjectRequired

notesstringRequired

titlestringRequired

pinnedbooleanRequired

reporterobjectRequired

semesterobjectRequired

schoolTagslist of objectsRequired

visibleToAdminsbooleanRequired

visibleToStudentbooleanRequired

visibleToTeachersbooleanRequired

visibleToGuardiansbooleanRequired

Response headers

Pragmastring

Expiresstring

Cache-Controlstring

X-Frame-Optionsstring

X-XSS-Protectionstring

Access-Control-Max-Agestring

X-Content-Type-Optionsstring

Access-Control-Allow-Originstring

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Expose-Headersstring

Access-Control-Allow-Credentialsstring

Response

idinteger

notesstring

titlestring

pinnedboolean

userIdinteger

createatdatetime

updatedAtdatetime

reportedIdinteger

schoolTagslist of integers

visibleToAdminsboolean

visibleToStudentboolean

visibleToTeachersboolean

visibleToGuardiansboolean