# Periskope Docs

## Docs

- [Org & Chat Assistant](https://docs.periskope.app/ai/agent/ai-assistant.md)
- [AI Dictate](https://docs.periskope.app/ai/agent/ai-dictate.md)
- [Built-in Tools](https://docs.periskope.app/ai/agent/built-in-tools.md): Configure the built-in actions your AI Agent can take in conversations
- [Custom Tools](https://docs.periskope.app/ai/agent/custom-tools.md): Connect your AI Agent to your own APIs so it can fetch real-time data and take actions in external systems
- [AI Agent Overview](https://docs.periskope.app/ai/agent/overview.md): Introduction to Periskope's AI Agent - what it is, how it works, and how to enable it
- [Personalization](https://docs.periskope.app/ai/agent/personalization.md): Define your AI Agent's role, instructions, personality, and activation behavior
- [Agent Settings](https://docs.periskope.app/ai/agent/settings.md): Configure how your AI Agent activates, responds, and behaves across all conversations
- [Knowledge Base](https://docs.periskope.app/ai/agent/training.md): Train your AI Agent with FAQs, documents, and self-learned context for accurate, reliable responses
- [Flag Messages with AI](https://docs.periskope.app/ai/flagging.md): Guide to automatically flag important messages with Periskope AI
- [Periskope Whatsapp MCP](https://docs.periskope.app/ai/mcp.md): Ask questions and take action on your Whatsapp using AI tools
- [Respond & Escalate to Humans](https://docs.periskope.app/ai/respond-and-esclate-to-humans-1.md)
- [AI Summaries and Responses](https://docs.periskope.app/ai/summaries.md): Guide to generate chat summaries and craft contextual responses with Periskope AI
- [Translate with AI](https://docs.periskope.app/ai/translate-with-ai.md)
- [Authorization](https://docs.periskope.app/api-reference/authorization.md): How to authenticate your requests to Periskope
- [Accept Group Invite](https://docs.periskope.app/api-reference/chat/accept-group-invite.md): This endpoint allows a user to accept a group invite
- [Add Participant to Group](https://docs.periskope.app/api-reference/chat/add-participant.md): This endpoint adds a participant to a group
- [Create Group](https://docs.periskope.app/api-reference/chat/create-group.md): This endpoint creates a new group.  - Note that creating a new 1-1 chat does not require any explicit API. Sending a message will automatically create the chat
- [Demote Participant to Member](https://docs.periskope.app/api-reference/chat/demote-participant-to-member.md): This endpoint demotes a participant in a group to member
- [Get Chat By ID](https://docs.periskope.app/api-reference/chat/get-chat-by-id.md): This endpoint retrieves a specific chat from its chat_id
- [Get Messages in a Chat](https://docs.periskope.app/api-reference/chat/get-messages-in-chat.md): This endpoint retrieves a paginated list of all messages for the specific chat_id (in descending order of timestamp)
- [Get Notifications in a Chat](https://docs.periskope.app/api-reference/chat/get-notifications-in-chat.md): This endpoint retrieves a paginated list of all notifications for the specific chat_id (in descending order of timestamp)
- [Get Private Notes in a Chat](https://docs.periskope.app/api-reference/chat/get-private-notes-in-chat.md): This endpoint retrieves a paginated list of all private notes from a specific chat (in descending order of timestamp).
- [Leave Group](https://docs.periskope.app/api-reference/chat/leave-group.md): This endpoint allows a participant to leave a group
- [List All Chats](https://docs.periskope.app/api-reference/chat/list-all-chats.md): This endpoint retrieves a paginated list of chats
- [List All Messages](https://docs.periskope.app/api-reference/chat/list-all-messages.md): This endpoint retrieves a paginated list of all messages across chats (in descending order of timestamp)
- [List All Notifications](https://docs.periskope.app/api-reference/chat/list-all-notifications.md): This endpoint retrieves a paginated list of all notifications across chats (in descending order of timestamp)
- [Mark chat as read](https://docs.periskope.app/api-reference/chat/mark-read.md): This endpoint marks a unread chat as read.
- [Update Chat Access](https://docs.periskope.app/api-reference/chat/override-chat-access.md): This endpoint overrides the default chat access for a user. This can only be used to provide access to users for a chat and cannot be used to remove access.
- [Promote Participant to Admin](https://docs.periskope.app/api-reference/chat/promote-participant-to-admin.md): This endpoint promotes a participant in a group to admin
- [Generate a new invite link for a chat](https://docs.periskope.app/api-reference/chat/refresh-invite.md): Generate a new invite link for a chat
- [Remove Participant from Group](https://docs.periskope.app/api-reference/chat/remove-participant.md): This endpoint removes a participant from a group
- [Update Chat](https://docs.periskope.app/api-reference/chat/update-chat.md): This endpoint updates properties of a chat
- [Update Chat Labels](https://docs.periskope.app/api-reference/chat/update-chat-labels.md): This endpoint updates the labels for specific chats
- [Update Group Settings](https://docs.periskope.app/api-reference/chat/update-group-settings.md): This endpoint updates the settings of the group
- [Check Contact Exists](https://docs.periskope.app/api-reference/contacts/check-contact.md): This endpoint checks if contacts exist on WhatsApp
- [Create Contact](https://docs.periskope.app/api-reference/contacts/create-contact.md): This endpoint creates a new contact.
- [Get Contact By ID](https://docs.periskope.app/api-reference/contacts/get-contact-by-id.md): This endpoint retrieves a specific contact along with all associated `chat_ids` (1-1 chats and common groups).
- [Get Contacts](https://docs.periskope.app/api-reference/contacts/get-contacts.md): This endpoint retrieves a paginated list of contacts
- [Update Contact](https://docs.periskope.app/api-reference/contacts/update-contact.md): This endpoint updates properties of a contact
- [Update Contact Labels](https://docs.periskope.app/api-reference/contacts/update-contact-labels.md): This endpoint updates the labels for specific contacts
- [WhatsApp Message Ack Status](https://docs.periskope.app/api-reference/delivery-status.md): Understanding WhatsApp acknowledgment statuses and what they mean for your messages
- [Introduction](https://docs.periskope.app/api-reference/introduction.md): Automate your WhatsApp with Periskope APIs
- [Create Document](https://docs.periskope.app/api-reference/knowledge-base/create-document.md): Process and create document entries in the knowledge base. The document will be split into chunks for efficient retrieval.
- [Create FAQ](https://docs.periskope.app/api-reference/knowledge-base/create-faq.md): Create a new FAQ entry in the knowledge base
- [Delete Document](https://docs.periskope.app/api-reference/knowledge-base/delete-document.md): Delete all entries and storage files for a document by document_id
- [Delete FAQ](https://docs.periskope.app/api-reference/knowledge-base/delete-faq.md): Delete a single FAQ entry by context_id
- [Get All Knowledge Base Items](https://docs.periskope.app/api-reference/knowledge-base/get-all-knowledge-base.md): This endpoint retrieves a paginated list of all knowledge base items (FAQs and Documents)
- [Get Document by ID](https://docs.periskope.app/api-reference/knowledge-base/get-document-by-id.md): Get a single document by document_id
- [Get FAQ by ID](https://docs.periskope.app/api-reference/knowledge-base/get-faq-by-id.md): Get a single FAQ entry by context_id
- [Update FAQ](https://docs.periskope.app/api-reference/knowledge-base/update-faq.md): Update an FAQ's question and answer (regenerates embedding)
- [Delete Member](https://docs.periskope.app/api-reference/members/delete-member.md): Delete a member by email address.
- [Invite Members](https://docs.periskope.app/api-reference/members/invite-members.md): Invite one or more members to the organization. Optionally set role and default access (labels and orgPhones).
- [Update Member Access](https://docs.periskope.app/api-reference/members/update-member-access.md): Update access (labels and org phones) for multiple members with role 'member'. At least one of labels or orgPhones must be provided.
- [Broadcast Message](https://docs.periskope.app/api-reference/message/broadcast-message.md): This endpoint is used to send bulk messages to many chats
- [Delete Message](https://docs.periskope.app/api-reference/message/delete-message.md): This endpoint deletes a message based on the `message_id` or `queue_id` to be deleted
- [Edit Message](https://docs.periskope.app/api-reference/message/edit-message.md): This endpoint edits a message based on the `message_id` or `queue_id`
- [Forward Message](https://docs.periskope.app/api-reference/message/forward-message.md): This endpoint forwards a message to other chats
- [Get Message](https://docs.periskope.app/api-reference/message/get-message.md): This endpoint retrieves a specific message based on the `message_id` or `queue_id`
- [List All Message Queues](https://docs.periskope.app/api-reference/message/list-queue-jobs.md): This endpoint returns the jobs in the message queue. Optionally filter by `queue_id` or `broadcast_id`
- [Get Message Status](https://docs.periskope.app/api-reference/message/message-status.md): This endpoint retrieves the delivery status of a message based on the `unique_id` of the message
- [Pin Message](https://docs.periskope.app/api-reference/message/pin-message.md): This endpoint pins or unpins a message based on the `message_id` or `queue_id`
- [Purge Message Queues](https://docs.periskope.app/api-reference/message/purge-queue-jobs.md): This endpoint purges jobs from the message queue
- [Get Status of Message Queues](https://docs.periskope.app/api-reference/message/queue-health.md): This endpoint returns the current status across all the message queue
- [React to Message](https://docs.periskope.app/api-reference/message/react-to-message.md): This endpoint reacts to a message based on the `message_id` or `queue_id`
- [Send Message](https://docs.periskope.app/api-reference/message/send-message.md): This endpoint is used to send a message to a chat
- [Send Private Notes](https://docs.periskope.app/api-reference/notes/create-private-notes.md): This endpoint is used to send private notes to a chat.
- [Get Private Note](https://docs.periskope.app/api-reference/notes/get-private-note.md): This endpoint retrieves a specific private note based on a specific `note_id`.
- [List All Private Notes](https://docs.periskope.app/api-reference/notes/list-all-private-notes.md): This endpoint retrieves a paginated list of all private notes across chats (in descending order of timestamp).
- [The Chat Notification Object](https://docs.periskope.app/api-reference/objects/the-chat-notification-object.md): The Chat Notification object represents a chat update notification in WhatsApp.
- [The Chat Object](https://docs.periskope.app/api-reference/objects/the-chat-object.md): The Chat object represents a chat in WhatsApp.
- [The Contact Object](https://docs.periskope.app/api-reference/objects/the-contact-object.md): The Contact object represents a contact in WhatsApp.
- [The Message Object](https://docs.periskope.app/api-reference/objects/the-message-object.md): The message object represents a message sent or received on WhatsApp.
- [The Private Note Object](https://docs.periskope.app/api-reference/objects/the-note-object.md): This object represents a private note created within a chat on Periskope.
- [The Phone Object](https://docs.periskope.app/api-reference/objects/the-phone-object.md): The Phone object represents an organisation phone on Periskope.
- [The Reaction Object](https://docs.periskope.app/api-reference/objects/the-reaction-object.md): The Reaction object represents a message reaction in WhatsApp.
- [The Ticket Object](https://docs.periskope.app/api-reference/objects/the-ticket-info-object.md): The Ticket Info Object represents a ticket on Periskope.
- [Create Phone](https://docs.periskope.app/api-reference/phones/create-phone.md): This endpoint will create a new phone for your organization
- [Delete Phone](https://docs.periskope.app/api-reference/phones/delete-phone.md): This endpoint will delete the phone from your organization
- [Get All Phones](https://docs.periskope.app/api-reference/phones/get-all-phones.md): This endpoint retrieves a list of all phones associated with this account
- [Get phone](https://docs.periskope.app/api-reference/phones/get-phone.md): This endpoint retrieves information about the phone (specified in the x-phone header)
- [Get QR](https://docs.periskope.app/api-reference/phones/get-qr.md): This endpoint retrieves the QR code of the phone (specified in the x-phone header).
- [Reset Phone](https://docs.periskope.app/api-reference/phones/reset-phone.md): This endpoint will logout the session and reset the phone connection to the QR state.
- [Restart Phone](https://docs.periskope.app/api-reference/phones/restart-phone.md): This endpoint restarts the phone connection
- [Resync Phone](https://docs.periskope.app/api-reference/phones/resync-phone.md): This endpoint is triggers a resynchronization of all data between the phone and WhatsApp
- [Update phone](https://docs.periskope.app/api-reference/phones/update-phone.md): This endpoint updates properties of the phone
- [Fetch Queue Jobs](https://docs.periskope.app/api-reference/queues/fetch-queue-jobs.md): This endpoint returns the jobs currently in the queue
- [Get Broadcast Status](https://docs.periskope.app/api-reference/queues/get-broadcast-status.md): Retrieves the status of a broadcast message by its ID
- [Get Queue Status](https://docs.periskope.app/api-reference/queues/get-queue-status.md): This endpoint returns the current status of the message queue
- [Purge Queue](https://docs.periskope.app/api-reference/queues/purge-queue.md): This endpoint purges the jobs in the queue
- [Get Reactions](https://docs.periskope.app/api-reference/reactions/get-reactions.md): This endpoint is used to fetch reactions for an org or a specific chat or message.
- [SDK](https://docs.periskope.app/api-reference/sdk.md): Build with Periskope using our Typescript SDK
- [Create Ticket](https://docs.periskope.app/api-reference/tickets/create-ticket.md): This endpoint creates a new Ticket.
- [Get Ticket By ID](https://docs.periskope.app/api-reference/tickets/get-ticket-by-id.md): This endpoint retrieves a specific ticket along with the associated chat, and messages
- [Get Tickets](https://docs.periskope.app/api-reference/tickets/get-tickets.md): This endpoint retrieves a paginated list of tickets
- [Update Ticket](https://docs.periskope.app/api-reference/tickets/update-ticket.md): This endpoint updates properties of a ticket
- [chat.created](https://docs.periskope.app/api-reference/webhooks/chat.created.md): The `chat.created` webhook is triggered when a new group or individual chat is created on whatsapp.
- [chat.custom-properties.updated](https://docs.periskope.app/api-reference/webhooks/chat.custom-properties.updated.md): The `chat.custom_properties.updated` webhook is triggered when a new group or individual chat is created on WhatsApp.
- [chat.notification.created](https://docs.periskope.app/api-reference/webhooks/chat.notification.created.md): The `chat.notification.created` webhook is triggered when any action is performed on a chat. For e.g. when a member is added or removed from a chat, when group settings is updated.
- [Create Webhook](https://docs.periskope.app/api-reference/webhooks/create-webhook.md): This endpoint creates a new webhook subscription
- [Delete Webhook](https://docs.periskope.app/api-reference/webhooks/delete-webhook.md): This endpoint deletes a webhook by its ID
- [Get Webhook by ID](https://docs.periskope.app/api-reference/webhooks/get-webhook-by-id.md): This endpoint retrieves a specific webhook by its ID
- [Introduction](https://docs.periskope.app/api-reference/webhooks/introduction.md): Listen to events on Periskope and build your custom integrations
- [List Webhooks](https://docs.periskope.app/api-reference/webhooks/list-webhooks.md): This endpoint retrieves a list of webhooks with optional filtering
- [message.ack.updated](https://docs.periskope.app/api-reference/webhooks/message.ack.updated.md): The `message.ack.updated` webhook is triggered when a new message is received or sent on whatsapp.
- [message.created](https://docs.periskope.app/api-reference/webhooks/message.created.md): The `message.created` webhook is triggered when a new message is received or sent on whatsapp.
- [message.deleted](https://docs.periskope.app/api-reference/webhooks/message.deleted.md): The `message.deleted` webhook is triggered when a message is deleted on whatsapp.
- [message.flagged](https://docs.periskope.app/api-reference/webhooks/message.flagged.md): The `message.flagged` webhook is triggered when a message is flagged on Periskope.
- [message.ticket.attached](https://docs.periskope.app/api-reference/webhooks/message.ticket.attached.md): The `message.ticket.attached` webhook is triggered when a message is attached to a ticket.
- [message.unflagged](https://docs.periskope.app/api-reference/webhooks/message.unflagged.md): The `message.unflagged` webhook is triggered when a message is unflagged on Periskope.
- [message.updated](https://docs.periskope.app/api-reference/webhooks/message.updated.md): The `message.updated` webhook is triggered when a message is edited on whatsapp.
- [note.created](https://docs.periskope.app/api-reference/webhooks/note.created.md): The `note.created` webhook is triggered when a private note is sent to a chat on Periskope.
- [org.phone.connected](https://docs.periskope.app/api-reference/webhooks/org.phone.connected.md): The `org.phone.connected` webhook is triggered when your org phone changes to a connected state from a disconnected state.
- [org.phone.disconnected](https://docs.periskope.app/api-reference/webhooks/org.phone.disconnected.md): The `org.phone.disconnected` webhook is triggered when your org phone changes to a disconnected state.
- [org.phone.qr](https://docs.periskope.app/api-reference/webhooks/org.phone.qr.md): The `org.phone.qr` webhook is triggered your when your org phone's QR code changes
- [org.phone.updated](https://docs.periskope.app/api-reference/webhooks/org.phone.updated.md): The `org.phone.updated` webhook is triggered when your org phone number, name or image changes.
- [reaction.created](https://docs.periskope.app/api-reference/webhooks/reaction.created.md): The `reaction.created` webhook is triggered when a reaction is created on Whatsapp.
- [reaction.updated](https://docs.periskope.app/api-reference/webhooks/reaction.updated.md): The `reaction.updated` webhook is triggered when a reaction is updated on Periskope.
- [ticket.created](https://docs.periskope.app/api-reference/webhooks/ticket.created.md): The `ticket.created` webhook is triggered when a new ticket is created on Periskope.
- [ticket.deleted](https://docs.periskope.app/api-reference/webhooks/ticket.deleted.md): The `ticket.deleted` webhook is triggered when a ticket is deleted on Periskope.
- [ticket.updated](https://docs.periskope.app/api-reference/webhooks/ticket.updated.md): The `ticket.updated` webhook is triggered when ticket details are updated on Periskope.
- [Update Webhook](https://docs.periskope.app/api-reference/webhooks/update-webhook.md): This endpoint updates a webhook. At least one field must be provided for update.
- [Automated Assignment](https://docs.periskope.app/automated-assignment.md)
- [Automated Escalation](https://docs.periskope.app/automated-escalation.md)
- [Automated Flagging](https://docs.periskope.app/automated-flagging.md)
- [Automated Notifications](https://docs.periskope.app/automated-notifications.md)
- [Automated Replies](https://docs.periskope.app/automated-replies.md)
- [Automated Ticketing](https://docs.periskope.app/automated-ticketing-rules.md)
- [Export and Analyze Your Data](https://docs.periskope.app/export-and-analyze-your-data.md)
- [Sending a Bulk Message](https://docs.periskope.app/features/bulk-message.md): Guide to schedule and send bulk messages to multiple WhatsApp groups & 1:1 chats with custom text, video, images
- [Bulk Message Logs](https://docs.periskope.app/features/bulk-message-logs.md): Guide to view bulk message logs, and stop and restart ongoing bulk messages
- [Creating Message Templates](https://docs.periskope.app/features/bulk-message-template.md): Guide to creating templates for recurring use for bulk-messaging
- [Variables in Bulk Messages](https://docs.periskope.app/features/bulk-message-variables.md): Guide to personalise bulk messages with variables
- [Chat List Bulk Actions](https://docs.periskope.app/features/chat-bulk-actions.md): If you're managing hundreds of WhatsApp chats, updating them one by one — adding labels, archiving, or organising — just doesn't scale. With Bulk Actions in Periskope, you can select multiple chats and make changes across all of them in seconds.
- [Custom Properties for Tickets](https://docs.periskope.app/features/custom-properties-for-tickets.md)
- [Custom Properties for chat](https://docs.periskope.app/features/custom-properties-v2.md): Learn how to create and manage custom properties for WhatsApp chats and tickets
- [Analytics](https://docs.periskope.app/features/dashboard-metrics.md): Guide to view and understand WhatsApp usage metrics via the Periskope dashboard
- [Data Exports](https://docs.periskope.app/features/export-data.md): Export chat data, group members, contact attributes and files
- [Labels](https://docs.periskope.app/features/labels.md): Intuitively organize chats, contacts and tickets with labels and custom properties
- [Create and Use Labels](https://docs.periskope.app/features/labels-use.md)
- [Multi-Agent Access](https://docs.periskope.app/features/multi-agent-access.md): Give multiple users access to manage, view and respond to messages without being on WhatsApp
- [Multi-Number Inbox](https://docs.periskope.app/features/multi-number-inbox.md): Connect and manage multiple WhatsApp numbers from a single dashboard
- [Private Notes](https://docs.periskope.app/features/private-note.md): When a customer conversation needs another teammate's attention, Private Notes let you leave internal messages directly inside a chat — visible only to your team, never to the customer.
- [Quick Replies](https://docs.periskope.app/features/quick-replies.md)
- [Scheduled & Recurring Messages](https://docs.periskope.app/features/recurring-scheduled-messages.md): Schedule one-time and recurring messages to be sent automatically to your customers
- [Sharing Access While Protecting Privacy](https://docs.periskope.app/features/untitled-page-1.md)
- [Best Practices for WhatsApp Outreach](https://docs.periskope.app/get-started/best-practices.md): Essential best practices and recommendations for safe WhatsApp outreach
- [Connect WhatsApp to Periskope](https://docs.periskope.app/get-started/connect-whatsapp.md): Guide to connecting your WhatsApp numbers to Periskope
- [Introduction](https://docs.periskope.app/get-started/introduction.md): Your guide to get up and running with Periskope WhatsApp platform
- [Setting up your account](https://docs.periskope.app/get-started/setup-account.md): Guide to setting up your organization account on Periskope
- [Warming Up New Numbers](https://docs.periskope.app/get-started/warmup-numbers.md): A guide on warming up new numbers to improve the behavior scores and avoid bans
- [Components of Automation Rules](https://docs.periskope.app/integrations/automation-rules/components.md)
- [What are Automation Rules?](https://docs.periskope.app/integrations/automation-rules/overview.md): Automation rules is a powerful feature in Periskope that allow you to automate your monitoring and alerting workflows. You can create rules that trigger actions based on specific conditions.
- [Setting up Automation Rules](https://docs.periskope.app/integrations/automation-rules/setup.md): Guide to set up automation rules in Periskope
- [Freshdesk](https://docs.periskope.app/integrations/freshdesk.md): Guide to setup Freshdesk Integration on Periskope
- [Google Sheets](https://docs.periskope.app/integrations/google-sheets.md): Connect Whatsapp to Google Sheets
- [HubSpot](https://docs.periskope.app/integrations/hubspot.md): Guide to connect your HubSpot account with Periskope
- [Actions](https://docs.periskope.app/integrations/workflows/actions.md)
- [Overview](https://docs.periskope.app/integrations/workflows/overview.md): Workflows are a powerful feature in Periskope that allow you to automate your monitoring and alerting workflows. You can create workflows that trigger actions based on specific conditions.
- [Triggers](https://docs.periskope.app/integrations/workflows/triggers.md)
- [Zapier](https://docs.periskope.app/integrations/zapier.md): Guide to setup zapier triggers on Periskope
- [Zoho CRM](https://docs.periskope.app/integrations/zohocrm.md): Guide to connect your Zoho CRM account with Periskope
- [Zohodesk](https://docs.periskope.app/integrations/zohodesk.md): Guide to setup Zohodesk Integration on Periskope
- [Create Ticket with an Emoji](https://docs.periskope.app/tasks-and-reminders/emoji-ticketing.md)
- [Create a Task](https://docs.periskope.app/tasks-and-reminders/tasks.md): Convert any WhatsApp message into a task with one click. Instantly create, assign, and manage tasks without leaving the chat.
- [Create a Ticket on WhatsApp](https://docs.periskope.app/tickets/create-ticket.md): Convert any WhatsApp message into a support ticket with one click. Instantly create, assign, and manage tickets without leaving the chat.
- [Track and Export Ticket Metrics](https://docs.periskope.app/track-and-export-ticket-metrics.md)
- [Fix "Blank screen or Out of memory issues"](https://docs.periskope.app/troubleshooting/clear-cache.md): Guide to fix app crashes across different browsers
- [Fix "Can't use Periskope due to App crashes"](https://docs.periskope.app/troubleshooting/clear-memory.md): Guide to fix app crashes across different devices
- [Fix "Chats not loading"](https://docs.periskope.app/troubleshooting/loading-chat.md): Guide to fix chats not loading issue on different browsers
- [Fix "Not receiving notifications on Periskope"](https://docs.periskope.app/troubleshooting/notifications.md): Guide to enable Periskope notifications on different devices

## OpenAPI Specs

- [openapi](https://docs.periskope.app/api-reference/openapi.json)
- [package](https://docs.periskope.app/package.json)
- [.prettierrc](https://docs.periskope.app/.prettierrc.json)

## Optional

- [Free Tools](https://tools.periskope.app)