# Periskope Docs - [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 - [Connect WhatsApp to Periskope](https://docs.periskope.app/get-started/connect-whatsapp.md): Guide to connecting your WhatsApp numbers to Periskope - [Best Practices](https://docs.periskope.app/get-started/best-practices.md): Essential best practices and recommendations for safe WhatsApp outreach — behavior scores, warm numbers, unknown-number outreach, group additions, and restrictions - [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 - [Multi-Number Inbox](https://docs.periskope.app/features/multi-number-inbox.md): Connect and manage multiple WhatsApp numbers from a single dashboard - [Team Access & Roles](https://docs.periskope.app/features/team-access-roles.md): Invite team members, assign roles, manage chat access, and control agent availability across your workspace. - [Number Masking & Privacy](https://docs.periskope.app/features/number-masking-privacy.md): Give team members access to manage WhatsApp chats without exposing customer phone numbers or your full inbox. - [Media Privacy](https://docs.periskope.app/features/media-privacy.md): Serve WhatsApp media through secure Periskope URLs with organization-level access control and expiring links. - [Labels](https://docs.periskope.app/features/labels.md): Create and use labels to organise and filter chats, contacts, and tickets across your workspace. - [Custom Properties](https://docs.periskope.app/features/custom-properties.md): Create custom fields to organise and track information across your WhatsApp chats and groups. - [Quick Replies](https://docs.periskope.app/features/quick-replies.md) - [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. - [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 - [Chat List Bulk Actions](https://docs.periskope.app/features/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. - [Calling](https://docs.periskope.app/features/calling.md): Make and receive WhatsApp voice calls from Periskope, and review every call with its recording, transcript and AI summary. - [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. - [Create Ticket with an Emoji](https://docs.periskope.app/tasks-and-reminders/emoji-ticketing.md) - [Custom Properties for Tickets](https://docs.periskope.app/features/custom-properties-for-tickets.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. - [Sending a Bulk Message](https://docs.periskope.app/features/bulk-message.md): Guide to send bulk messages to multiple WhatsApp groups & 1:1 chats with custom text, video, images - instantly or scheduled for a specific date and time. - [Repeating Bulk Messages](https://docs.periskope.app/features/bulk-message-repeating.md): Set up repeating bulk messages that go out automatically on a daily, weekly, or monthly schedule. - [Variables & Message Templates](https://docs.periskope.app/features/bulk-message-variables-templates.md): Personalise bulk messages with per-contact variables and save reusable message templates for future broadcasts. - [Saved Chat Lists](https://docs.periskope.app/features/bulk-message-saved-chat-lists.md): Save a list of groups and contacts under a name and reload them instantly when creating any future broadcast. - [Logs](https://docs.periskope.app/features/bulk-message-logs.md): View bulk message logs, stop ongoing broadcasts, retry failed messages, and duplicate previous broadcasts. - [Broadcast Credits](https://docs.periskope.app/features/bulk-message-credits.md): Understand how broadcast credits work, how many you get each month, and how to top up when you need more. - [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 - [Activation](https://docs.periskope.app/ai/agent/settings.md): Configure when your AI Agent responds, how long it waits, and the hours it operates in - [Personalization](https://docs.periskope.app/ai/agent/personalization.md): Define your AI Agent's identity, role, instructions, and personality - [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 - [Self-Training](https://docs.periskope.app/ai/agent/self-training.md): Let the AI learn from your team's resolved chats every week, and review or re-run its training - [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 - [Connectors](https://docs.periskope.app/ai/agent/connectors.md): Connect your AI Agent to your own systems over MCP so it can look things up and take actions - [Agent Mode](https://docs.periskope.app/ai/agent/agent-mode.md): Tell Periskope what you need in plain words. It works across your chats, tickets, rules, bulk messages and settings, shows each step, and asks before changing anything. - [Org & Chat Assistant](https://docs.periskope.app/ai/agent/ai-assistant.md) - [AI Dictate](https://docs.periskope.app/ai/agent/ai-dictate.md) - [AI Credits](https://docs.periskope.app/features/ai-credits.md): Understand how AI credits work, how many you get each month, and how to top up when you need more. - [Flag Messages with AI](https://docs.periskope.app/ai/flagging.md): Guide to automatically flag important messages with Periskope AI - [AI Summaries and Responses](https://docs.periskope.app/ai/summaries.md): Guide to generate chat summaries and craft contextual responses with Periskope AI - [Periskope Whatsapp MCP](https://docs.periskope.app/ai/mcp.md): Connect your AI assistant to WhatsApp in seconds using Periskope's hosted MCP server - [Respond & Escalate to Humans](https://docs.periskope.app/ai/respond-and-esclate-to-humans-1.md) - [Translate with AI](https://docs.periskope.app/ai/translate-with-ai.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. - [Components of Automation Rules](https://docs.periskope.app/integrations/automation-rules/components.md) - [Setting up Automation Rules](https://docs.periskope.app/integrations/automation-rules/setup.md): Guide to set up automation rules in Periskope - [Automated Ticketing](https://docs.periskope.app/automated-ticketing-rules.md) - [Automated Replies](https://docs.periskope.app/automated-replies.md) - [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) - [Export and Analyze Your Data](https://docs.periskope.app/export-and-analyze-your-data.md) - [Track and Export Ticket Metrics](https://docs.periskope.app/track-and-export-ticket-metrics.md) - [Workspace Metrics](https://docs.periskope.app/features/workspace-metrics.md): View and understand message, ticket, and team performance metrics across your Periskope workspace - [Data Exports](https://docs.periskope.app/features/export-data.md): Export chat data, group members, contact attributes and files - [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) - [Actions](https://docs.periskope.app/integrations/workflows/actions.md) - [HubSpot](https://docs.periskope.app/integrations/hubspot.md): Guide to connect your HubSpot account with Periskope - [Zoho CRM](https://docs.periskope.app/integrations/zohocrm.md): Guide to connect your Zoho CRM account with Periskope - [Google Sheets](https://docs.periskope.app/integrations/google-sheets.md): Connect Whatsapp to Google Sheets - [Freshdesk](https://docs.periskope.app/integrations/freshdesk.md): Guide to setup Freshdesk Integration on Periskope - [Zohodesk](https://docs.periskope.app/integrations/zohodesk.md): Guide to setup Zohodesk Integration on Periskope - [Zapier](https://docs.periskope.app/integrations/zapier.md): Guide to setup zapier triggers on Periskope - [Fix "Not receiving notifications on Periskope"](https://docs.periskope.app/troubleshooting/notifications.md): Guide to enable Periskope notifications on different devices - [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 "Blank screen or Out of memory issues"](https://docs.periskope.app/troubleshooting/clear-cache.md): Guide to fix app crashes across different browsers - [Fix "Chats not loading"](https://docs.periskope.app/troubleshooting/loading-chat.md): Guide to fix chats not loading issue on different browsers - [Introduction](https://docs.periskope.app/api-reference/introduction.md): Automate your WhatsApp with Periskope APIs - [Authorization](https://docs.periskope.app/api-reference/authorization.md): How to authenticate your requests to Periskope - [SDK](https://docs.periskope.app/api-reference/sdk.md): Build with Periskope using our Typescript SDK - [The Chat Object](https://docs.periskope.app/api-reference/objects/the-chat-object.md): A WhatsApp chat (1-1 conversation or group) synced into the workspace, together with its Periskope attributes (labels, assignee, custom properties, status). - [The Chat Notification Object](https://docs.periskope.app/api-reference/objects/the-chat-notification-object.md): A chat notification — a group system event such as participants being added or removed, admin changes or setting changes, or a call-log entry (type "call"). Stored in tbl_chat_notifications. - [The Call Object](https://docs.periskope.app/api-reference/objects/the-call-object.md): A WhatsApp call on one of the organization's phones: who called whom, how it ended and, for calls handled in Periskope, its recording, participants, transcript and summary. - [The Reaction Object](https://docs.periskope.app/api-reference/objects/the-reaction-object.md): An emoji reaction on a WhatsApp message, synced from a connected org phone. Reactions reference the message they were applied to via message_id and carry who reacted (sender_id) and with which emoji (reaction). - [The Message Object](https://docs.periskope.app/api-reference/objects/the-message-object.md): A WhatsApp message record. Responses may include additional raw fields of the underlying record (id, author, links, location, vcards, is_forwarded, has_media, message_ticket_id, ...). - [The Contact Object](https://docs.periskope.app/api-reference/objects/the-contact-object.md): A WhatsApp contact known to the workspace — synced from a connected phone's address book and chats, or created via the API. Contacts belong to the org as a whole, not to a single phone. Labels on a contact are shared with the contact's 1-1 chat. - [The Ticket Info Object](https://docs.periskope.app/api-reference/objects/the-ticket-info-object.md): A ticket together with its chat, the message it was raised from and (on GET /tickets/{ticket_id}) the messages attached to it. - [The Task Object](https://docs.periskope.app/api-reference/objects/the-task-object.md): A task in the workspace. Tasks are either standalone to-dos (type: todo) or linked to a chat, message or ticket via association. Tasks belong to the workspace as a whole, not to a specific phone. - [The Phone Object](https://docs.periskope.app/api-reference/objects/the-phone-object.md): A phone — a slot in the workspace that a WhatsApp account connects to by scanning a QR code. All phone-scoped endpoints act through one phone, selected with the x-phone header (org phone number or phone_id). - [The Note Object](https://docs.periskope.app/api-reference/objects/the-note-object.md): A private note attached to a chat. Notes are internal to the workspace — they are never sent to WhatsApp and contacts cannot see them. Notes share the message record shape, so responses may include additional message fields (ack, sender_phone, sent_message_id, unique_id). - [WhatsApp Message Ack Status](https://docs.periskope.app/api-reference/delivery-status.md): Understanding WhatsApp acknowledgment statuses and what they mean for your messages - [Get Chat By ID](https://docs.periskope.app/api-reference/chat/get-chat-by-id.md): Retrieves a chat by its chat_id, including its participants. - [Get Messages in a Chat](https://docs.periskope.app/api-reference/chat/get-messages-in-chat.md): Returns the messages of a chat, newest first. An unknown chat_id returns an empty page. - [Get Private Notes in a Chat](https://docs.periskope.app/api-reference/chat/get-private-notes-in-chat.md): Returns the private notes of a chat, newest first. Notes are internal to the workspace and never sent to WhatsApp. - [Get Notifications in a Chat](https://docs.periskope.app/api-reference/chat/get-notifications-in-chat.md): Returns the group system events of a chat (participants added or removed, admin and setting changes) and its call-log entries (type "call"), newest first. Call entries carry downloadable recording links in call_metadata; the Calls endpoints return calls in a cleaner shape with filters. - [List All Chats](https://docs.periskope.app/api-reference/chat/list-all-chats.md): Returns a paginated list of chats, newest first. Filter by chat_id, chat_type, label or a created_at time window. - [List All Messages](https://docs.periskope.app/api-reference/chat/list-all-messages.md): Returns messages across all chats, newest first. For a single chat use GET /chats/{chat_id}/messages. - [List All Notifications](https://docs.periskope.app/api-reference/chat/list-all-notifications.md): Returns group system events (participants added or removed, admin and setting changes) and call-log entries (type "call") across all chats, newest first. Call entries carry downloadable recording links in call_metadata; the Calls endpoints return calls in a cleaner shape with filters. - [Update Chat Labels](https://docs.periskope.app/api-reference/chat/update-chat-labels.md): Applies labels to one or more chats; unknown label names are created automatically. Replaces the current labels unless replace is false. Pass null or an empty string as labels to remove every label. - [Update Chat](https://docs.periskope.app/api-reference/chat/update-chat.md): Updates the Periskope attributes of a chat — labels, custom_properties, assigned_to and/or status. At least one is required. Pass null (or an empty value) to clear labels or assigned_to; custom_properties is merged per key. - [Mark chat as read](https://docs.periskope.app/api-reference/chat/mark-read.md): Marks all messages in the chat as read, clearing its unread count. - [Update Chat Access](https://docs.periskope.app/api-reference/chat/override-chat-access.md): Overrides member access on one or more chats via a map of member email to access flag. Merges into existing overrides unless replace is true. Pass null or an empty object as access with replace true to remove every override. - [Get Chat Audit Logs](https://docs.periskope.app/api-reference/chat/get-chat-audit-logs.md): Returns the audit trail of a chat — who changed what and when — newest first. Filter by performed_by and action, and restrict to a timestamp window. - [Update Chat AI Settings](https://docs.periskope.app/api-reference/chat/update-chat-ai-settings.md): Toggles the AI permissions of this chat: whether the AI agent may reply to messages and whether AI flagging may flag them. At least one flag is required; omitted flags are unchanged. - [Create Group](https://docs.periskope.app/api-reference/chat/create-group.md): Creates a WhatsApp group through the phone in the x-phone header and returns its chat object. Participants whose privacy settings disallow direct adds receive an invite instead. - [Generate a new invite link for a chat](https://docs.periskope.app/api-reference/chat/refresh-invite.md): Revokes the invite link of the group and returns a new one — the old link stops working. - [Add Participant to Group](https://docs.periskope.app/api-reference/chat/add-participant.md): Adds the given phone numbers to the group. Participants whose privacy settings disallow direct adds receive an invite; returns a per-participant outcome map. - [Remove Participant from Group](https://docs.periskope.app/api-reference/chat/remove-participant.md): Removes the given participants from the group. Returns a per-participant outcome map. - [Promote Participant to Admin](https://docs.periskope.app/api-reference/chat/promote-participant-to-admin.md): Promotes the given participants to group admin. Returns a per-participant outcome map. - [Demote Participant to Member](https://docs.periskope.app/api-reference/chat/demote-participant-to-member.md): Demotes the given admins back to regular members. Returns a per-participant outcome map. - [Update Group Settings](https://docs.periskope.app/api-reference/chat/update-group-settings.md): Updates the WhatsApp settings of a group — name, description, icon, admin-only restrictions and disappearing messages. At least one is required; group chats only. - [Accept Group Invite](https://docs.periskope.app/api-reference/chat/accept-group-invite.md): Joins a group with the phone in the x-phone header, using the invite_code from a WhatsApp invite link. - [Leave Group](https://docs.periskope.app/api-reference/chat/leave-group.md): Makes the phone in the x-phone header leave the group. Group chats only. - [Send Message](https://docs.periskope.app/api-reference/message/send-message.md): Sends a message (text, media and/or poll) to a chat from the phone in the x-phone header. For group chats the header can be omitted — a connected phone that is in the group is selected automatically, within the token's phone scopes. Sending is asynchronous — track the returned unique_id via GET /mes… - [Send Sync Message](https://docs.periskope.app/api-reference/message/send-message-sync.md): Sends a message like POST /message/send (including automatic phone selection for group chats when x-phone is omitted), then waits up to sync_timeout seconds (default 20) for WhatsApp to accept or reject the message. When accepted in time the response carries the sent message record (status sent). Wh… - [Broadcast Message](https://docs.periskope.app/api-reference/message/broadcast-message.md): Sends the same message (text, media or poll) to many chats — from chat_ids, or every chat carrying the given label. One credit per recipient; rejected up front when credits are insufficient. - [Delete a Broadcast](https://docs.periskope.app/api-reference/message/delete-broadcast.md): Cancels a scheduled broadcast or stops one in progress. Unsent messages are cancelled and their credits refunded. - [Delete Message](https://docs.periskope.app/api-reference/message/delete-message.md): Deletes a message for everyone in the chat. Permanent, and subject to the WhatsApp delete-for-everyone time window. - [Edit Message](https://docs.periskope.app/api-reference/message/edit-message.md): Edits the text (or media caption) of a message sent by the phone. Media content and polls cannot be edited. - [Forward Message](https://docs.periskope.app/api-reference/message/forward-message.md): Forwards a message to one or more chats. Returns a map of forward_chat_id to success. - [Get Message](https://docs.periskope.app/api-reference/message/get-message.md): Retrieves a message record with its reactions. Accepts a message_id or the unique_id from the send response. - [React to Message](https://docs.periskope.app/api-reference/message/react-to-message.md): Adds an emoji reaction to a message; reacting again replaces the previous reaction. Pass an empty string or null as reaction to remove it. - [Pin Message](https://docs.periskope.app/api-reference/message/pin-message.md): Pins a message in its chat (pin: true) or unpins it. time sets the pin duration in days: 1, 7 or 30 (default 30). - [Get Message Status](https://docs.periskope.app/api-reference/message/message-status.md): Tracks a message sent via POST /message/send by its unique_id: queued, scheduled, sending or failed while queued, then sent, delivered, read or played. - [List All Message Queues](https://docs.periskope.app/api-reference/message/list-queue-jobs.md): Lists the jobs retained in the send queue of the phone. Pass broadcast_id to track a broadcast, or queue_id for a single job. - [Get Status of Message Queues](https://docs.periskope.app/api-reference/message/queue-health.md): Returns live counters of the send queue of the phone: running state plus active, pending, completed and failed job counts. - [Purge Message Queues](https://docs.periskope.app/api-reference/message/purge-queue-jobs.md): Removes unsubmitted jobs from the send queue of the phone, by queue_ids or broadcast_id. Warning: an empty body purges the entire queue. - [List Scheduled Messages](https://docs.periskope.app/api-reference/scheduled-messages/list-scheduled-messages.md): Returns the scheduled messages of the workspace, by next run time. Filter by chat, creator, status and repetition, search the message text, and restrict to a scheduled_at window. - [Schedule a Message](https://docs.periskope.app/api-reference/scheduled-messages/schedule-message.md): Schedules a message (text and/or media) to be sent to a chat from the phone in the x-phone header at scheduled_at — once, or repeating per repeat_config. The send itself happens in the background at run time. - [Get Scheduled Message](https://docs.periskope.app/api-reference/scheduled-messages/get-scheduled-message.md): Retrieves a scheduled message by its scheduled_id. - [Update Scheduled Message](https://docs.periskope.app/api-reference/scheduled-messages/update-scheduled-message.md): Updates a pending scheduled message — content, next run time, repetition, pause/resume or skip-next. Completed messages cannot be updated. - [Delete Scheduled Message](https://docs.periskope.app/api-reference/scheduled-messages/delete-scheduled-message.md): Permanently deletes a scheduled message — no further runs happen. Its run history stays available via the occurrences endpoint. - [List Scheduled Message Runs](https://docs.periskope.app/api-reference/scheduled-messages/list-scheduled-message-occurrences.md): Returns the run history of a scheduled message, newest first — each run records whether it sent, failed or was skipped, and the resulting message id. - [List Calls](https://docs.periskope.app/api-reference/calls/list-calls.md): Returns the organization's call history, newest first, with recording links and AI summaries for calls handled in Periskope. Use Get a call for the transcript. - [Get Call](https://docs.periskope.app/api-reference/calls/get-call.md): Returns one call in full, including its transcript. Accepts the call_id or the notification_id. - [Migrate Media URL](https://docs.periskope.app/api-reference/media/migrate-url.md): Convert a legacy Google Cloud Storage media URL to the new Periskope media URL format - [Migrate Media URLs (Batch)](https://docs.periskope.app/api-reference/media/migrate-url-batch.md): Convert up to 1000 legacy Google Cloud Storage media URLs to the new Periskope media URL format in a single request - [Get Contact By ID](https://docs.periskope.app/api-reference/contacts/get-contact-by-id.md): Looks up a contact by phone number, including the chat_ids of every chat it participates in. - [Get Contacts](https://docs.periskope.app/api-reference/contacts/get-contacts.md): Returns a paginated list of contacts, ordered by name. Contacts are org-level — no x-phone header needed. - [Update Contact Labels](https://docs.periskope.app/api-reference/contacts/update-contact-labels.md): Sets the labels of one or more contacts; label names that do not exist yet are created automatically. Pass null or an empty string as labels to remove every label. - [Update Contact](https://docs.periskope.app/api-reference/contacts/update-contact.md): Updates the name, internal flag and/or labels of a contact — at least one is required. Name changes apply on Periskope only. - [Create Contact](https://docs.periskope.app/api-reference/contacts/create-contact.md): Creates a contact, or updates the existing one with the same contact_id (upsert). contact_id must be a possible phone number. - [Check Contact Exists](https://docs.periskope.app/api-reference/contacts/check-contact.md): Checks whether each given number is registered on WhatsApp, live through the phone in the x-phone header (must be connected). - [Get Ticket By ID](https://docs.periskope.app/api-reference/tickets/get-ticket-by-id.md): Looks up a ticket by its ticket_id, together with its chat and the message it was raised from. - [Get Tickets](https://docs.periskope.app/api-reference/tickets/get-tickets.md): Returns the tickets of the workspace, newest first, excluding deleted tickets. - [Update Ticket](https://docs.periskope.app/api-reference/tickets/update-ticket.md): Updates a ticket — any combination of the body fields, at least one required. labels replaces the entire label set. - [Create Ticket](https://docs.periskope.app/api-reference/tickets/create-ticket.md): Creates a ticket on a chat (chat_id and subject required). Only one ticket can be raised per message. Custom property values cannot be set at creation — use the update endpoint after. - [Get Ticket Audit Logs](https://docs.periskope.app/api-reference/tickets/get-ticket-audit-logs.md): Returns the audit trail of a ticket — who changed what and when — newest first. Filter by performed_by and action, and restrict to a timestamp window. - [Get All Custom Properties](https://docs.periskope.app/api-reference/properties/get-all-custom-properties.md): Returns every custom property (chat and ticket), including dropdown and picklist options. Filter with the type query param. - [Get Custom Property](https://docs.periskope.app/api-reference/properties/get-custom-property.md): Looks up a custom property by property_id or name (case-insensitive), including its options. - [Create Custom Property](https://docs.periskope.app/api-reference/properties/create-custom-property.md): Creates a custom property for chats or tickets. Options apply to dropdown and picklist kinds. - [Update Custom Property](https://docs.periskope.app/api-reference/properties/update-custom-property.md): Updates the name, section and/or mandatory flag of a custom property — at least one is required. - [Update Property Options](https://docs.periskope.app/api-reference/properties/update-property-options.md): Adds or removes options on a dropdown or picklist property. Adding is idempotent on the label (case-insensitive). - [Delete Custom Properties](https://docs.periskope.app/api-reference/properties/delete-custom-property.md): Deletes one or more custom properties, by property_ids or names, via ticket_properties and/or chat_properties. - [Get Task By ID](https://docs.periskope.app/api-reference/tasks/get-task-by-id.md): Looks up a task by its task_id. Responds 404 when no task matches. - [Get All Tasks](https://docs.periskope.app/api-reference/tasks/get-tasks.md): Returns the tasks of the workspace, newest first, across every task kind. - [Create Task](https://docs.periskope.app/api-reference/tasks/create-task.md): Creates a task — standalone (type: todo, default) or linked to a chat, message or ticket via type and the matching id. - [Update Task](https://docs.periskope.app/api-reference/tasks/update-task.md): Updates a task — any combination of title, status, priority, assignee, due_date, notes and remind_at; at least one required. The type and associations cannot change. - [Fetch Queue Jobs](https://docs.periskope.app/api-reference/queues/fetch-queue-jobs.md): Lists the jobs in the send queue of the phone — scheduled, waiting, in flight, completed or failed. - [Get Broadcast Status](https://docs.periskope.app/api-reference/queues/get-broadcast-status.md): Returns the aggregate delivery status of a broadcast: sent, failed and pending counts, delivered/read percentages, and scheduling info. - [Get Queue Status](https://docs.periskope.app/api-reference/queues/get-queue-status.md): Returns the live status of the message send queue of the phone in the x-phone header. - [Purge Queue](https://docs.periskope.app/api-reference/queues/purge-queue.md): Removes jobs from the send queue by queue_id or broadcast_id. Warning: an omitted or empty body purges the ENTIRE queue. Messages already submitted to WhatsApp are unaffected. - [Get phone](https://docs.periskope.app/api-reference/phones/get-phone.md): Returns the phone in the x-phone header, refreshing its state from the live instance when reachable. - [Get All Phones](https://docs.periskope.app/api-reference/phones/get-all-phones.md): Returns every phone the API token can access. No x-phone header needed. - [Get QR](https://docs.periskope.app/api-reference/phones/get-qr.md): Returns the QR code of the phone as an HTML page with an inline PNG. Scan it with WhatsApp (Settings > Linked Devices) to connect. - [Reset Phone](https://docs.periskope.app/api-reference/phones/reset-phone.md): Logs out the WhatsApp session and resets the phone to the QR state — rescan via GET /phones/qr to reconnect. - [Restart Phone](https://docs.periskope.app/api-reference/phones/restart-phone.md): Restarts the instance of the phone — works even while the phone server is switched off. - [Resync Phone](https://docs.periskope.app/api-reference/phones/resync-phone.md): Triggers a full resync between WhatsApp and Periskope for the phone. The phone must be connected. - [Update phone](https://docs.periskope.app/api-reference/phones/update-phone.md): Updates the display name, profile image and/or labels of the phone. Name and image changes are pushed to WhatsApp. - [Create Phone](https://docs.periskope.app/api-reference/phones/create-phone.md): Creates a new phone in the workspace and boots its instance. Do not send an x-phone header. - [Delete Phone](https://docs.periskope.app/api-reference/phones/delete-phone.md): Permanently deletes the phone and tears down its instance. Cannot be undone. - [Send Private Notes](https://docs.periskope.app/api-reference/notes/create-private-notes.md): Adds a private note (message, media, or both) to a chat. Notes are internal — never sent to WhatsApp. @-mentioning a member email creates a task for them. - [Get Private Note](https://docs.periskope.app/api-reference/notes/get-private-note.md): Looks up a private note by its note_id. Responds 200 with null (not 404) when no note matches. - [List All Private Notes](https://docs.periskope.app/api-reference/notes/list-all-private-notes.md): Returns private notes across all chats, newest first. - [Get Reactions](https://docs.periskope.app/api-reference/reactions/get-reactions.md): Returns emoji reactions across the workspace, newest first. Filter by chat_id and/or message_id. - [Get All Knowledge Base Items](https://docs.periskope.app/api-reference/knowledge-base/get-all-knowledge-base.md): Returns every entry in the AI knowledge base — FAQs, document chunks and self-learned entries — newest first. - [Get FAQ by ID](https://docs.periskope.app/api-reference/knowledge-base/get-faq-by-id.md): Fetches a knowledge-base entry by its context_id. - [Create FAQ](https://docs.periskope.app/api-reference/knowledge-base/create-faq.md): Creates an FAQ — a question/answer pair the AI agent learns to answer from. Its embedding is generated automatically. The entry starts inactive unless is_active is sent as true. - [Update FAQ](https://docs.periskope.app/api-reference/knowledge-base/update-faq.md): Updates the FAQ addressed by the path context_id. Send question and answer together to replace the text and regenerate its embedding (attachments are then cleared unless resent); attachments and is_active can also be updated alone — omitted fields stay unchanged. - [Delete FAQ](https://docs.periskope.app/api-reference/knowledge-base/delete-faq.md): Permanently deletes an FAQ by its context_id. Only entries of type faq are deleted. - [Get Document by ID](https://docs.periskope.app/api-reference/knowledge-base/get-document-by-id.md): Returns every chunk extracted from an uploaded document, by its document_id. - [Create Document](https://docs.periskope.app/api-reference/knowledge-base/create-document.md): Ingests a PDF into the AI knowledge base. Provide the document as exactly one of document.url, document.base64 or document.file. - [Delete Document](https://docs.periskope.app/api-reference/knowledge-base/delete-document.md): Permanently deletes an uploaded document by document_id — every chunk extracted from it plus the stored PDF. - [Invite Members](https://docs.periskope.app/api-reference/members/invite-members.md): Invites people to the org by email. New emails become pending members and receive an invite email; existing members are unchanged. - [Update Member Access](https://docs.periskope.app/api-reference/members/update-member-access.md): Replaces the chat access scope (labels and orgPhones) of members with role member. Both dimensions are written on every call — an omitted or null dimension is cleared, not left unchanged. - [Delete Member](https://docs.periskope.app/api-reference/members/delete-member.md): Removes a member from the org by email. Permanent — access is lost immediately. - [Trigger AI Reply](https://docs.periskope.app/api-reference/ai/trigger-ai-reply.md): Queues the org AI agent to reply to a message in a chat. Asynchronous — 200 means the run was accepted, not sent. Requires the AI agent to be available and enabled for the org and allowed in the chat. - [List Webhooks](https://docs.periskope.app/api-reference/webhooks/list-webhooks.md): Returns the webhook subscriptions of the workspace, newest first. One row exists per subscribed event type. - [Create Webhook](https://docs.periskope.app/api-reference/webhooks/create-webhook.md): Subscribes an endpoint URL to one or more event types — one subscription row per event type, sharing an integration_id. - [Get Webhook by ID](https://docs.periskope.app/api-reference/webhooks/get-webhook-by-id.md): Looks up a webhook subscription row by its id. - [Update Webhook](https://docs.periskope.app/api-reference/webhooks/update-webhook.md): Updates a webhook subscription row — at least one of hookUrl, integrationName, integrationMetadata, integrationType, isSubscribed or name. - [Delete Webhook](https://docs.periskope.app/api-reference/webhooks/delete-webhook.md): Permanently deletes a webhook subscription row by id. Its sibling rows (same create call) are marked unsubscribed — to pause without deleting, use PATCH with isSubscribed: false. - [Introduction](https://docs.periskope.app/api-reference/webhooks/introduction.md): Listen to events on Periskope and build your custom integrations - [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.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. - [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. - [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.updated](https://docs.periskope.app/api-reference/webhooks/message.updated.md): The `message.updated` webhook is triggered when a message is edited 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.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.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.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.unflagged](https://docs.periskope.app/api-reference/webhooks/message.unflagged.md): The `message.unflagged` webhook is triggered when a message is unflagged on Periskope. - [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. - [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.updated](https://docs.periskope.app/api-reference/webhooks/ticket.updated.md): The `ticket.updated` webhook is triggered when ticket details are updated 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. - [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. - [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 ## OpenAPI Specs - [.prettierrc](/.prettierrc.json) - [openapi-generated](/api-reference/openapi-generated.json) - [openapi](/api-reference/openapi.json) - [package](/package.json) ## Optional - [Free Tools](https://tools.periskope.app) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.