> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://apidoc.dreamclass.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://apidoc.dreamclass.io/_mcp/server.

# AddNote

POST https://dreamclassapi/v1/settings/notes
Content-Type: application/json

Add a new note

Semester: Check the GetSchoolPeriods call

User/Reporter: Check the GetStudent

School Tags: Check the Tags call

Reference: https://apidoc.dreamclass.io/dream-class-api/notes/add-note

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: collection
  version: 1.0.0
paths:
  /dreamclassapi/v1/settings/notes:
    post:
      operationId: add-note
      summary: AddNote
      description: |-
        Add a new note

        Semester: Check the GetSchoolPeriods call

        User/Reporter: Check the GetStudent

        School Tags: Check the Tags call
      tags:
        - subpackage_notes
      parameters:
        - name: tenant
          in: header
          required: false
          schema:
            type: string
        - name: schoolCode
          in: header
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Notes_AddNote_Response_200'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                user:
                  $ref: >-
                    #/components/schemas/DreamclassapiV1SettingsNotesPostRequestBodyContentApplicationJsonSchemaUser
                notes:
                  type: string
                title:
                  type: string
                pinned:
                  type: boolean
                reporter:
                  $ref: >-
                    #/components/schemas/DreamclassapiV1SettingsNotesPostRequestBodyContentApplicationJsonSchemaReporter
                semester:
                  $ref: >-
                    #/components/schemas/DreamclassapiV1SettingsNotesPostRequestBodyContentApplicationJsonSchemaSemester
                schoolTags:
                  type: array
                  items:
                    $ref: >-
                      #/components/schemas/DreamclassapiV1SettingsNotesPostRequestBodyContentApplicationJsonSchemaSchoolTagsItems
                visibleToAdmins:
                  type: boolean
                visibleToStudent:
                  type: boolean
                visibleToTeachers:
                  type: boolean
                visibleToGuardians:
                  type: boolean
              required:
                - user
                - notes
                - title
                - pinned
                - reporter
                - semester
                - schoolTags
                - visibleToAdmins
                - visibleToStudent
                - visibleToTeachers
                - visibleToGuardians
servers:
  - url: https:/
    description: https://{server}
  - url: https://your-webhook-url
    description: https://your-webhook-url
components:
  schemas:
    DreamclassapiV1SettingsNotesPostRequestBodyContentApplicationJsonSchemaUser:
      type: object
      properties:
        id:
          type: integer
      required:
        - id
      title: >-
        DreamclassapiV1SettingsNotesPostRequestBodyContentApplicationJsonSchemaUser
    DreamclassapiV1SettingsNotesPostRequestBodyContentApplicationJsonSchemaReporter:
      type: object
      properties:
        id:
          type: integer
      required:
        - id
      title: >-
        DreamclassapiV1SettingsNotesPostRequestBodyContentApplicationJsonSchemaReporter
    DreamclassapiV1SettingsNotesPostRequestBodyContentApplicationJsonSchemaSemester:
      type: object
      properties:
        id:
          type: integer
      required:
        - id
      title: >-
        DreamclassapiV1SettingsNotesPostRequestBodyContentApplicationJsonSchemaSemester
    DreamclassapiV1SettingsNotesPostRequestBodyContentApplicationJsonSchemaSchoolTagsItems:
      type: object
      properties:
        id:
          type: integer
      required:
        - id
      title: >-
        DreamclassapiV1SettingsNotesPostRequestBodyContentApplicationJsonSchemaSchoolTagsItems
    Notes_AddNote_Response_200:
      type: object
      properties:
        id:
          type: integer
        notes:
          type: string
        title:
          type: string
        pinned:
          type: boolean
        userId:
          type: integer
        createat:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        reportedId:
          type: integer
        schoolTags:
          type: array
          items:
            type: integer
        visibleToAdmins:
          type: boolean
        visibleToStudent:
          type: boolean
        visibleToTeachers:
          type: boolean
        visibleToGuardians:
          type: boolean
      required:
        - id
        - notes
        - title
        - pinned
        - userId
        - createat
        - updatedAt
        - reportedId
        - schoolTags
        - visibleToAdmins
        - visibleToStudent
        - visibleToTeachers
        - visibleToGuardians
      title: Notes_AddNote_Response_200

```

## Examples



**Request**

```json
{
  "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
}
```

**Response**

```json
{
  "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
}
```

**SDK Code**

```python Notes_AddNote_example
import requests

url = "https://https/dreamclassapi/v1/settings/notes"

payload = {
    "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
}
headers = {
    "tenant": "{{tenant}}",
    "schoolCode": "{{schoolCode}}",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Notes_AddNote_example
const url = 'https://https/dreamclassapi/v1/settings/notes';
const options = {
  method: 'POST',
  headers: {
    tenant: '{{tenant}}',
    schoolCode: '{{schoolCode}}',
    'Content-Type': 'application/json'
  },
  body: '{"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}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Notes_AddNote_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://https/dreamclassapi/v1/settings/notes"

	payload := strings.NewReader("{\n  \"user\": {\n    \"id\": 23\n  },\n  \"notes\": \"<p>Sample note</p>\",\n  \"title\": \"Test Note\",\n  \"pinned\": true,\n  \"reporter\": {\n    \"id\": 27\n  },\n  \"semester\": {\n    \"id\": 1\n  },\n  \"schoolTags\": [\n    {\n      \"id\": 23\n    }\n  ],\n  \"visibleToAdmins\": false,\n  \"visibleToStudent\": true,\n  \"visibleToTeachers\": true,\n  \"visibleToGuardians\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("tenant", "{{tenant}}")
	req.Header.Add("schoolCode", "{{schoolCode}}")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Notes_AddNote_example
require 'uri'
require 'net/http'

url = URI("https://https/dreamclassapi/v1/settings/notes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["tenant"] = '{{tenant}}'
request["schoolCode"] = '{{schoolCode}}'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"user\": {\n    \"id\": 23\n  },\n  \"notes\": \"<p>Sample note</p>\",\n  \"title\": \"Test Note\",\n  \"pinned\": true,\n  \"reporter\": {\n    \"id\": 27\n  },\n  \"semester\": {\n    \"id\": 1\n  },\n  \"schoolTags\": [\n    {\n      \"id\": 23\n    }\n  ],\n  \"visibleToAdmins\": false,\n  \"visibleToStudent\": true,\n  \"visibleToTeachers\": true,\n  \"visibleToGuardians\": false\n}"

response = http.request(request)
puts response.read_body
```

```java Notes_AddNote_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://https/dreamclassapi/v1/settings/notes")
  .header("tenant", "{{tenant}}")
  .header("schoolCode", "{{schoolCode}}")
  .header("Content-Type", "application/json")
  .body("{\n  \"user\": {\n    \"id\": 23\n  },\n  \"notes\": \"<p>Sample note</p>\",\n  \"title\": \"Test Note\",\n  \"pinned\": true,\n  \"reporter\": {\n    \"id\": 27\n  },\n  \"semester\": {\n    \"id\": 1\n  },\n  \"schoolTags\": [\n    {\n      \"id\": 23\n    }\n  ],\n  \"visibleToAdmins\": false,\n  \"visibleToStudent\": true,\n  \"visibleToTeachers\": true,\n  \"visibleToGuardians\": false\n}")
  .asString();
```

```php Notes_AddNote_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://https/dreamclassapi/v1/settings/notes', [
  'body' => '{
  "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
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'schoolCode' => '{{schoolCode}}',
    'tenant' => '{{tenant}}',
  ],
]);

echo $response->getBody();
```

```csharp Notes_AddNote_example
using RestSharp;

var client = new RestClient("https://https/dreamclassapi/v1/settings/notes");
var request = new RestRequest(Method.POST);
request.AddHeader("tenant", "{{tenant}}");
request.AddHeader("schoolCode", "{{schoolCode}}");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"user\": {\n    \"id\": 23\n  },\n  \"notes\": \"<p>Sample note</p>\",\n  \"title\": \"Test Note\",\n  \"pinned\": true,\n  \"reporter\": {\n    \"id\": 27\n  },\n  \"semester\": {\n    \"id\": 1\n  },\n  \"schoolTags\": [\n    {\n      \"id\": 23\n    }\n  ],\n  \"visibleToAdmins\": false,\n  \"visibleToStudent\": true,\n  \"visibleToTeachers\": true,\n  \"visibleToGuardians\": false\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Notes_AddNote_example
import Foundation

let headers = [
  "tenant": "{{tenant}}",
  "schoolCode": "{{schoolCode}}",
  "Content-Type": "application/json"
]
let parameters = [
  "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
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://https/dreamclassapi/v1/settings/notes")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```