Skip to main content

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.

These notes are only visible to your teammates on Periskope and they do not appear on WhatsApp.
Attributes
​
message_id
string
A unique identifier for the private note, containing information about the chat, user, and note details.
​
org_id
string
The unique identifier of the organization where the note was created.
​
org_phone
string
The organization phone ID linked to the chat (in the format {phone_number}@c.us).
​
body
string
The text content of the private note.
​
chat_id
string
The unique identifier of the chat where the private note was added.
​
from_me
boolean
Indicates if the note was created by the organization user.
​
is_private_note
boolean
Always true for private notes.
​
is_deleted
boolean | null
Is set to true if the private note is deleted. It is null otherwise.
​
prev_body
string | null
The original content of the note before editing (if applicable).
​
quoted_message_id
string | null
The ID of the message to which this note is replying, if any.
​
sender_phone
string
The phone identifier of the organization account that added the note.
​
sent_message_id
string
ID of the created private note (matches unique_id).
​
performed_by
string
Email address of the user who created the private note.
​
timestamp
string
ISO 8601 formatted timestamp when the private note was created.
​
updated_at
string
ISO 8601 formatted timestamp when the private note was last updated.
​
unique_id
string
A unique identifier for the private note.
​
mentioned_ids
string[]
Array of Email IDs (format: @<email>) mentioned in the private note.
​
media
object | null
Media content attached to the private note, if present.
  {
      "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..."
      }
  }