Request Body

The request body includes the content of the note and the document it should be associated with.

Response Structure

The response returns the full details of the newly created note, including its unique identifier, creator information, timestamps, the note text itself, and the document it is linked to. It also includes system metadata such as status flags, author, and event properties used for internal tracking and UI display.

name – Unique ID automatically generated for the note.
owner – User who initially created the note.
creation – Timestamp of when the note was created.
modified – Timestamp of the last modification.
modified_by – User who last modified the note.
docstatus – Document status flag (0 = Draft, 1 = Submitted, 2 = Cancelled).
idx – System index value used internally.
author – User who authored the note content.
note – The actual text of the note.
reference_doctype – The type of document this note is linked to.
reference_document – The specific ID of the linked document.
is_system – Indicates whether the note was system-generated (0 = No, 1 = Yes).
event_type – Optional event category associated with the note.
event_color – Color tag used for UI display of events or notes.
is_edited – Indicates if the note content was edited after creation.
doctype – The Frappe/ERPNext doctype name: "Document Note".

Example Response

{
    "data": {
        "name": "fpjdu8v30f",
        "owner": "emotivesoftware@emotivesoftware.com",
        "creation": "2025-12-14 23:59:51.700722",
        "modified": "2025-12-14 23:59:51.700722",
        "modified_by": "emotivesoftware@emotivesoftware.com,
        "docstatus": 0,
        "idx": 0,
        "author": "lakshmi.ramasamy@emotivesoftware.com",
        "note": "Note 2",
        "reference_doctype": "LMS Lending Accounts",
        "reference_document": "LA-002886",
        "is_system": 0,
        "event_type": "",
        "event_color": "green",
        "is_edited": 0,
        "doctype": "Document Note"
    }
}