AddNote | DreamClass | Documentation

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

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

Add a new note

Semester: Check the GetSchoolPeriods call

User/Reporter: Check the GetStudent

School Tags: Check the Tags call

Headers

Request

This endpoint expects an object.

titlestringRequired

notesstringRequired

userobjectRequired

reporterobjectRequired

semesterobjectRequired

schoolTagslist of objectsRequired

visibleToStudentbooleanRequired

visibleToAdminsbooleanRequired

visibleToTeachersbooleanRequired

visibleToGuardiansbooleanRequired

pinnedbooleanRequired

Response headers

ExpiresstringOptional

Cache-ControlstringOptional

Access-Control-Allow-HeadersstringOptional

X-XSS-ProtectionstringOptional

PragmastringOptional

Access-Control-Allow-MethodsstringOptional

X-Frame-OptionsstringOptional

Access-Control-Expose-HeadersstringOptional

Access-Control-Allow-OriginstringOptional

Access-Control-Allow-CredentialsstringOptional

X-Content-Type-OptionsstringOptional

Access-Control-Max-AgestringOptional

Response

idinteger

titlestring

notesstring

createatdatetime

updatedAtdatetime

userIdinteger

reportedIdinteger

schoolTagslist of integers

visibleToStudentboolean

visibleToAdminsboolean

visibleToTeachersboolean

visibleToGuardiansboolean

pinnedboolean