> ## Documentation Index
> Fetch the complete documentation index at: https://docs.periskope.app/llms.txt
> Use this file to discover all available pages before exploring further.

# The Private Note Object

> This object represents a private note created within a chat on Periskope.

<Info>
  These notes are only visible to your teammates on Periskope and they do not appear on WhatsApp.
</Info>

**Attributes**

<ParamField path="message_id" type="string">
  A unique identifier for the private note, containing information about the chat, user, and note details.
</ParamField>

<ParamField path="org_id" type="string">
  The unique identifier of the organization where the note was created.
</ParamField>

<ParamField path="org_phone" type="string">
  The organization phone ID linked to the chat (in the format `{phone_number}@c.us`).
</ParamField>

<ParamField path="body" type="string">
  The text content of the private note.
</ParamField>

<ParamField path="chat_id" type="string">
  The unique identifier of the chat where the private note was added.
</ParamField>

<ParamField path="from_me" type="boolean">
  Indicates if the note was created by the organization user.
</ParamField>

<ParamField path="is_private_note" type="boolean">
  Always `true` for private notes.
</ParamField>

<ParamField path="is_deleted" type="boolean | null">
  Is set to `true` if the private note is deleted. It is `null` otherwise.
</ParamField>

<ParamField path="prev_body" type="string | null">
  The original content of the note before editing (if applicable).
</ParamField>

<ParamField path="quoted_message_id" type="string | null">
  The ID of the message to which this note is replying, if any.
</ParamField>

<ParamField path="sender_phone" type="string">
  The phone identifier of the organization account that added the note.
</ParamField>

<ParamField path="sent_message_id" type="string">
  ID of the created private note (matches `unique_id`).
</ParamField>

<ParamField path="performed_by" type="string">
  Email address of the user who created the private note.
</ParamField>

<ParamField path="timestamp" type="string">
  ISO 8601 formatted timestamp when the private note was created.
</ParamField>

<ParamField path="updated_at" type="string">
  ISO 8601 formatted timestamp when the private note was last updated.
</ParamField>

<ParamField path="unique_id" type="string">
  A unique identifier for the private note.
</ParamField>

<ParamField path="mentioned_ids" type="string[]">
  Array of Email IDs (format: `@<email>`) mentioned in the private note.
</ParamField>

<ParamField path="media" type="object | null">
  Media content attached to the private note, if present.

  <Expandable>
    <ParamField path="mimetype" type="string">
      The MIME type of the media.
    </ParamField>

    <ParamField path="filename" type="string">
      The filename of the media file.
    </ParamField>

    <ParamField path="filedata" type="string">
      The base64-encoded content of the file. Trimmed in examples.
    </ParamField>
  </Expandable>
</ParamField>

<ResponseExample>
  ```json The Private Note Object theme={null}
    {
        "message_id": "true_2634e275-ac58-4c85-892d-83882810fc1c_api",
        "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
        "ack": "3",
        "body": "Hello World",
        "from_me": true,
        "message_type": "chat",
        "chat_id": "91882424xxxx@c.us",
        "timestamp": "2025-08-18T13:38:37.203+00:00",
        "org_phone": "91882424xxxx@c.us",
        "performed_by": "api",
        "prev_body": null,
        "quoted_message_id": "52643136-1573-4011-ad22-b95ca6ea8e0c",
        "sender_phone": "91882424xxxx@c.us",
        "sent_message_id": "2634e275-ac58-4c85-892d-83882810fc1c",
        "updated_at": "2025-08-18T13:38:37.203+00:00",
        "is_private_note": true,
        "unique_id": "2634e275-ac58-4c85-892d-83882810fc1c",
        "mentioned_ids": [],
        "is_deleted": null
        "media": {
          "mimetype": "audio/wav",
          "filename": "beep.wav",
          "filedata": "data:audio/wav;base64,UklGRkKAAABXQVZFZm10IBAAAAABAAEAQB8A..."
        }
    }
  ```
</ResponseExample>