# Zeplo

## Docs

- [Introduction](https://docs.zeplo.ai/docs/introduction.md): Zeplo is the WhatsApp Business API platform for marketing, customer support, and automation at scale.
- [Quickstart](https://docs.zeplo.ai/docs/quickstart.md): Get up and running with the Zeplo API in under 5 minutes.
- [Authentication](https://docs.zeplo.ai/docs/authentication.md): Authenticate your API requests using session cookies or API keys.
- [JavaScript SDK](https://docs.zeplo.ai/docs/sdks/javascript.md): Integrate Zeplo's WhatsApp Business API into your JavaScript or TypeScript application using the official @zeplo/sdk package.
- [Python SDK](https://docs.zeplo.ai/docs/sdks/python.md): Integrate Zeplo's WhatsApp Business API into your Python application using the official zeplo package.
- [Messaging](https://docs.zeplo.ai/docs/features/messaging.md): Send and manage WhatsApp messages including text, images, documents, audio, video, stickers, contacts, location, and interactive messages through the Zeplo API.
- [Contacts](https://docs.zeplo.ai/docs/features/contacts.md): Manage your WhatsApp contacts with full CRUD operations, groups, tags, custom metadata, and bulk import through the Zeplo API.
- [Campaigns](https://docs.zeplo.ai/docs/features/campaigns.md): Create and manage bulk messaging campaigns with scheduling, audience targeting, template selection, and real-time analytics through the Zeplo API.
- [Automations](https://docs.zeplo.ai/docs/features/automations.md): Build visual automation flows with drag-and-drop triggers, conditions, delays, and action nodes to automate your WhatsApp customer interactions.
- [Templates](https://docs.zeplo.ai/docs/features/templates.md): Create, submit, and manage WhatsApp message templates with multi-language support, component editors, and approval tracking through the Zeplo API.
- [Webhooks](https://docs.zeplo.ai/docs/features/webhooks.md): Receive real-time event notifications about messages, conversations, and contacts with verified payloads, automatic retries, and easy testing tools.
- [WebSocket API](https://docs.zeplo.ai/docs/websocket-api/introduction.md): Connect to Zeplo's real-time WebSocket API for live messaging, typing indicators, agent status updates, and message tracking.
- [WebSocket Events](https://docs.zeplo.ai/docs/websocket-api/events.md): Reference for all client-to-server and server-to-client WebSocket events supported by the Zeplo real-time API.
- [WebSocket Authentication](https://docs.zeplo.ai/docs/websocket-api/authentication.md): Learn how to authenticate WebSocket connections to the Zeplo real-time API using API keys, session cookies, and token-based auth.
- [Zeplo CLI](https://docs.zeplo.ai/docs/cli-reference/introduction.md): Command-line interface for managing WhatsApp Business automation — contacts, campaigns, templates, messages, automations, and more.
- [Installation](https://docs.zeplo.ai/docs/cli-reference/installation.md): How to install and configure the Zeplo CLI.
- [Global Options](https://docs.zeplo.ai/docs/cli-reference/global-options.md): Flags and options that work with every Zeplo CLI command.
- [Authentication](https://docs.zeplo.ai/docs/cli-reference/commands/authentication.md): Manage your Zeplo CLI authentication credentials
- [Channels](https://docs.zeplo.ai/docs/cli-reference/commands/channels.md): Manage your WhatsApp and messaging channels
- [Contacts](https://docs.zeplo.ai/docs/cli-reference/commands/contacts.md): Create, list, import, export, and delete contacts
- [Campaigns](https://docs.zeplo.ai/docs/cli-reference/commands/campaigns.md): Create, manage, and analyze messaging campaigns
- [Templates](https://docs.zeplo.ai/docs/cli-reference/commands/templates.md): Manage WhatsApp message templates from the command line
- [Messages](https://docs.zeplo.ai/docs/cli-reference/commands/messages.md): Send text and template messages via WhatsApp from the command line
- [Conversations](https://docs.zeplo.ai/docs/cli-reference/commands/conversations.md): List, view, and reply to WhatsApp conversations from the command line
- [Inbox](https://docs.zeplo.ai/docs/cli-reference/commands/inbox.md): Real-time interactive WhatsApp inbox in the terminal
- [Automations](https://docs.zeplo.ai/docs/cli-reference/commands/automations.md): Create, manage, and execute Zeplo automations from the CLI
- [Database](https://docs.zeplo.ai/docs/cli-reference/commands/database.md): Manage database schemas, migrations, and seeding with the Zeplo CLI
- [Users](https://docs.zeplo.ai/docs/cli-reference/commands/users.md): List, create, and delete users in your Zeplo account
- [Analytics](https://docs.zeplo.ai/docs/cli-reference/commands/analytics.md): View analytics dashboards, message stats, and campaign performance
- [Config](https://docs.zeplo.ai/docs/cli-reference/commands/config.md): View and manage Zeplo CLI configuration values
- [Widget](https://docs.zeplo.ai/docs/cli-reference/commands/widget.md): Generate embed code and preview your Zeplo chat widget
- [Deploy](https://docs.zeplo.ai/docs/cli-reference/commands/deploy.md): Deploy, monitor, and manage your Zeplo server
- [MCP Server](https://docs.zeplo.ai/docs/mcp-server/introduction.md): Connect AI assistants to your Zeplo workspace using the Model Context Protocol. Manage campaigns, contacts, conversations, and more directly from Claude, Cursor, or any MCP-compatible tool.
- [Setup & Configuration](https://docs.zeplo.ai/docs/mcp-server/setup.md): Install and configure the Zeplo MCP Server for use with Claude Code, Cursor, and other MCP-compatible AI assistants.
- [System Tools](https://docs.zeplo.ai/docs/mcp-server/system-tools.md): Health checks, subscription plans, and system status tools for the Zeplo MCP Server.
- [Channel Tools](https://docs.zeplo.ai/docs/mcp-server/channel-tools.md): List, inspect, and diagnose WhatsApp channels with the Zeplo MCP Server.
- [Contact Tools](https://docs.zeplo.ai/docs/mcp-server/contact-tools.md): Create, search, update, and delete contacts with the Zeplo MCP Server.
- [Template Tools](https://docs.zeplo.ai/docs/mcp-server/template-tools.md): List, inspect, and check WhatsApp message template approval status with the Zeplo MCP Server.
- [Campaign Tools](https://docs.zeplo.ai/docs/mcp-server/campaign-tools.md): Create, manage, and analyze WhatsApp messaging campaigns with the Zeplo MCP Server.
- [Conversation Tools](https://docs.zeplo.ai/docs/mcp-server/conversation-tools.md): List, manage, and read messages in WhatsApp conversations with the Zeplo MCP Server.
- [Message Tools](https://docs.zeplo.ai/docs/mcp-server/message-tools.md): Send text and template messages, and view message statistics with the Zeplo MCP Server.
- [Analytics Tools](https://docs.zeplo.ai/docs/mcp-server/analytics-tools.md): Dashboard metrics, message delivery stats, campaign comparisons, and data exports with the Zeplo MCP Server.
- [Automation Tools](https://docs.zeplo.ai/docs/mcp-server/automation-tools.md): List, toggle, trigger, and inspect automation workflow executions with the Zeplo MCP Server.
- [Chatbot Tools](https://docs.zeplo.ai/docs/mcp-server/chatbot-tools.md): List, configure, train, and inspect AI chatbot training data with the Zeplo MCP Server.
- [Resources](https://docs.zeplo.ai/docs/mcp-server/resources.md): Read-only resources exposed by the Zeplo MCP Server for database schema, subscription plans, and API endpoint discovery.
- [API Reference Overview](https://docs.zeplo.ai/docs/api-reference/overview.md): Explore all available REST API endpoints organized by resource.
- [Troubleshooting](https://docs.zeplo.ai/docs/api-reference/troubleshooting.md): Diagnose and resolve common issues when working with the Zeplo API.
- [Rate Limits](https://docs.zeplo.ai/docs/rate-limits.md): Understand the API rate limits and how to handle them.
- [Errors](https://docs.zeplo.ai/docs/errors.md): Handle API errors gracefully with proper error codes and messages.
- [REST API v1 Overview](https://docs.zeplo.ai/docs/api-reference/rest-api-v1/overview.md): External API for integrations using API key authentication.
- [POST Send Template Message (v1)](https://docs.zeplo.ai/docs/api-reference/rest-api-v1/send-template.md): Send a WhatsApp template message via the external API.
- [POST Send Reply Message (v1)](https://docs.zeplo.ai/docs/api-reference/rest-api-v1/send-reply.md): Send a reply message via the external API.
- [GET/POST Contacts (v1)](https://docs.zeplo.ai/docs/api-reference/rest-api-v1/contacts-v1.md): Manage contacts via the external API with interactive testing.
- [GET Templates (v1)](https://docs.zeplo.ai/docs/api-reference/rest-api-v1/templates-v1.md): List WhatsApp templates with interactive testing.
- [GET/POST Webhooks (v1)](https://docs.zeplo.ai/docs/api-reference/rest-api-v1/webhooks-v1.md): Manage webhooks with interactive testing.
- [GET Account (v1)](https://docs.zeplo.ai/docs/api-reference/rest-api-v1/account-v1.md): Get account info and usage stats with interactive testing.
- [POST Send a Message](https://docs.zeplo.ai/docs/api-reference/messages/send-message.md): Send a WhatsApp message via the API. Supports text, images, documents, audio, video, stickers, contacts, and interactive messages.
- [GET List Messages](https://docs.zeplo.ai/docs/api-reference/messages/list-messages.md): Retrieve a paginated list of WhatsApp messages for a conversation.
- [GET Get Message](https://docs.zeplo.ai/docs/api-reference/messages/get-message.md): Retrieve a single message by its ID.
- [GET Message Status](https://docs.zeplo.ai/docs/api-reference/messages/message-status.md): Update the delivery status of a message.
- [GET List Conversations](https://docs.zeplo.ai/docs/api-reference/conversations/list-conversations.md): Retrieve all conversations with filtering and pagination.
- [GET Get Conversation](https://docs.zeplo.ai/docs/api-reference/conversations/get-conversation.md): Retrieve a single conversation by ID.
- [POST Create Conversation](https://docs.zeplo.ai/docs/api-reference/conversations/create-conversation.md): Start a new conversation with a contact.
- [PUT Update Conversation](https://docs.zeplo.ai/docs/api-reference/conversations/update-conversation.md): Update conversation status, assignment, and other properties.
- [DELETE Delete Conversation](https://docs.zeplo.ai/docs/api-reference/conversations/delete-conversation.md): Delete a conversation and all its messages.
- [GET List Contacts](https://docs.zeplo.ai/docs/api-reference/contacts/list-contacts.md): Retrieve contacts with pagination, filtering, and search.
- [POST Create Contact](https://docs.zeplo.ai/docs/api-reference/contacts/create-contact.md): Create a new contact in the system.
- [GET Get Contact](https://docs.zeplo.ai/docs/api-reference/contacts/get-contact.md): Retrieve a single contact by ID.
- [PUT Update Contact](https://docs.zeplo.ai/docs/api-reference/contacts/update-contact.md): Update an existing contact's details.
- [DELETE Delete Contact](https://docs.zeplo.ai/docs/api-reference/contacts/delete-contact.md): Delete a single contact or bulk delete contacts.
- [POST Import Contacts](https://docs.zeplo.ai/docs/api-reference/contacts/import-contacts.md): Import contacts from CSV or Excel files.
- [GET List Campaigns](https://docs.zeplo.ai/docs/api-reference/campaigns/list-campaigns.md): Retrieve all marketing campaigns with filtering.
- [POST Create Campaign](https://docs.zeplo.ai/docs/api-reference/campaigns/create-campaign.md): Create a new marketing campaign.
- [GET Get Campaign](https://docs.zeplo.ai/docs/api-reference/campaigns/get-campaign.md): Retrieve a single campaign by ID.
- [PUT Update Campaign Status](https://docs.zeplo.ai/docs/api-reference/campaigns/update-campaign-status.md): Pause, resume, or cancel a campaign.
- [POST Start Campaign](https://docs.zeplo.ai/docs/api-reference/campaigns/start-campaign.md): Start or schedule a campaign for execution.
- [DELETE Delete Campaign](https://docs.zeplo.ai/docs/api-reference/campaigns/delete-campaign.md): Permanently delete a campaign.
- [GET Campaign Analytics](https://docs.zeplo.ai/docs/api-reference/campaigns/campaign-analytics.md): Get delivery and engagement analytics for a campaign.
- [GET List Templates](https://docs.zeplo.ai/docs/api-reference/templates/list-templates.md): Retrieve WhatsApp message templates.
- [POST Create Template](https://docs.zeplo.ai/docs/api-reference/templates/create-template.md): Create a new WhatsApp message template.
- [GET Get Template](https://docs.zeplo.ai/docs/api-reference/templates/get-template.md): Retrieve a single template by ID.
- [PUT Update Template](https://docs.zeplo.ai/docs/api-reference/templates/update-template.md): Update an existing WhatsApp message template.
- [DELETE Delete Template](https://docs.zeplo.ai/docs/api-reference/templates/delete-template.md): Delete a WhatsApp message template.
- [POST Sync Templates](https://docs.zeplo.ai/docs/api-reference/templates/sync-templates.md): Sync local templates with WhatsApp.
- [GET List Automations](https://docs.zeplo.ai/docs/api-reference/automations/list-automations.md): Retrieve all automation workflows.
- [POST Create Automation](https://docs.zeplo.ai/docs/api-reference/automations/create-automation.md): Create a new automation workflow.
- [GET Get Automation](https://docs.zeplo.ai/docs/api-reference/automations/get-automation.md): Retrieve a single automation workflow.
- [PUT Update Automation](https://docs.zeplo.ai/docs/api-reference/automations/update-automation.md): Update an automation workflow's properties.
- [DELETE Delete Automation](https://docs.zeplo.ai/docs/api-reference/automations/delete-automation.md): Delete an automation workflow.
- [POST Toggle Automation](https://docs.zeplo.ai/docs/api-reference/automations/toggle-automation.md): Toggle an automation between active and inactive.
- [POST Execute Automation](https://docs.zeplo.ai/docs/api-reference/automations/execute-automation.md): Manually trigger an automation execution.
- [GET Automation Nodes & Edges](https://docs.zeplo.ai/docs/api-reference/automations/automation-nodes.md): Manage the visual flow builder nodes and edges for automations.
- [GET Automation Executions](https://docs.zeplo.ai/docs/api-reference/automations/automation-executions.md): Track and manage automation execution history.
- [GET List Channels](https://docs.zeplo.ai/docs/api-reference/channels/list-channels.md): Retrieve WhatsApp Business channels.
- [POST Create Channel](https://docs.zeplo.ai/docs/api-reference/channels/create-channel.md): Connect a new WhatsApp Business channel.
- [GET Get Channel](https://docs.zeplo.ai/docs/api-reference/channels/get-channel.md): Retrieve a single WhatsApp channel.
- [PUT Update Channel](https://docs.zeplo.ai/docs/api-reference/channels/update-channel.md): Update WhatsApp channel settings.
- [DELETE Delete Channel](https://docs.zeplo.ai/docs/api-reference/channels/delete-channel.md): Disconnect and remove a WhatsApp channel.
- [GET Channel Health](https://docs.zeplo.ai/docs/api-reference/channels/channel-health.md): Monitor channel health and connectivity.
- [GET Business Profile](https://docs.zeplo.ai/docs/api-reference/channels/business-profile.md): Manage WhatsApp Business profile settings.
- [POST Embedded Signup](https://docs.zeplo.ai/docs/api-reference/channels/embedded-signup.md): WhatsApp embedded signup flow for channel onboarding.
- [GET List Webhooks](https://docs.zeplo.ai/docs/api-reference/webhooks/list-webhooks.md): Retrieve webhook configurations.
- [POST Create Webhook](https://docs.zeplo.ai/docs/api-reference/webhooks/create-webhook.md): Register a new webhook endpoint.
- [PUT Update Webhook](https://docs.zeplo.ai/docs/api-reference/webhooks/update-webhook.md): Update a webhook configuration.
- [DELETE Delete Webhook](https://docs.zeplo.ai/docs/api-reference/webhooks/delete-webhook.md): Remove a webhook configuration.
- [POST Test Webhook](https://docs.zeplo.ai/docs/api-reference/webhooks/test-webhook.md): Send a test payload to a webhook endpoint.
- [POST Upload Media](https://docs.zeplo.ai/docs/api-reference/media/upload-media.md): Upload media files to WhatsApp.
- [GET Get Media URL](https://docs.zeplo.ai/docs/api-reference/media/get-media-url.md): Retrieve the download URL for a media file.
- [DELETE Delete Media](https://docs.zeplo.ai/docs/api-reference/media/delete-media.md): Delete a media file from WhatsApp storage.
- [GET Message Analytics](https://docs.zeplo.ai/docs/api-reference/analytics/message-analytics.md): Get message delivery and engagement analytics.
- [GET Campaign Analytics](https://docs.zeplo.ai/docs/api-reference/analytics/campaign-analytics.md): Get campaign performance analytics.
- [GET Export Analytics](https://docs.zeplo.ai/docs/api-reference/analytics/export-analytics.md): Export analytics data as CSV or JSON.
- [GET List Team Members](https://docs.zeplo.ai/docs/api-reference/teams/list-members.md): Retrieve team members with their roles and permissions.
- [POST Create Team Member](https://docs.zeplo.ai/docs/api-reference/teams/create-member.md): Add a new team member to the workspace.
- [PUT Update Team Member](https://docs.zeplo.ai/docs/api-reference/teams/update-member.md): Update a team member's details or status.
- [DELETE Delete Team Member](https://docs.zeplo.ai/docs/api-reference/teams/delete-member.md): Remove a team member from the workspace.
- [GET Member Permissions](https://docs.zeplo.ai/docs/api-reference/teams/member-permissions.md): Manage team member permission scopes.
- [GET List Groups](https://docs.zeplo.ai/docs/api-reference/groups/list-groups.md): Retrieve contact groups.
- [POST Create Group](https://docs.zeplo.ai/docs/api-reference/groups/create-group.md): Create a new contact group.
- [PUT Update Group](https://docs.zeplo.ai/docs/api-reference/groups/update-group.md): Update a contact group's name or description.
- [DELETE Delete Group](https://docs.zeplo.ai/docs/api-reference/groups/delete-group.md): Delete a contact group.
- [POST Manage Group Contacts](https://docs.zeplo.ai/docs/api-reference/groups/manage-group-contacts.md): Add or remove contacts from groups.
- [GET List Plans](https://docs.zeplo.ai/docs/api-reference/subscriptions/list-plans.md): Retrieve available subscription plans.
- [POST Create Plan](https://docs.zeplo.ai/docs/api-reference/subscriptions/create-plan.md): Create a new subscription plan (superadmin).
- [GET Get Subscription](https://docs.zeplo.ai/docs/api-reference/subscriptions/get-subscription.md): Retrieve subscription details for a user.
- [POST Create Subscription](https://docs.zeplo.ai/docs/api-reference/subscriptions/create-subscription.md): Create or assign a subscription.
- [PUT Update Subscription](https://docs.zeplo.ai/docs/api-reference/subscriptions/update-subscription.md): Update or renew a subscription.
- [POST Cancel Subscription](https://docs.zeplo.ai/docs/api-reference/subscriptions/cancel-subscription.md): Cancel a user subscription.
- [POST Initiate Payment](https://docs.zeplo.ai/docs/api-reference/payments/initiate-payment.md): Start a payment transaction.
- [POST Verify Payment](https://docs.zeplo.ai/docs/api-reference/payments/verify-payment.md): Verify a completed payment.
- [GET List Transactions](https://docs.zeplo.ai/docs/api-reference/payments/list-transactions.md): Retrieve payment transaction history.
- [POST Refund](https://docs.zeplo.ai/docs/api-reference/payments/refund.md): Process a payment refund.
- [GET List Notifications](https://docs.zeplo.ai/docs/api-reference/notifications/list-notifications.md): Retrieve user notifications.
- [POST Create Notification](https://docs.zeplo.ai/docs/api-reference/notifications/create-notification.md): Create a new notification.
- [POST Mark as Read](https://docs.zeplo.ai/docs/api-reference/notifications/mark-read.md): Mark notifications as read.
- [GET Notification Preferences](https://docs.zeplo.ai/docs/api-reference/notifications/preferences.md): Manage user notification preferences.
- [GET Platform Settings](https://docs.zeplo.ai/docs/api-reference/settings/platform-settings.md): Manage platform-wide configuration.
- [GET Brand Settings](https://docs.zeplo.ai/docs/api-reference/settings/brand-settings.md): Configure platform branding.
- [GET AI Settings](https://docs.zeplo.ai/docs/api-reference/settings/ai-settings.md): Configure AI chatbot settings for channels.
- [GET Storage Settings](https://docs.zeplo.ai/docs/api-reference/settings/storage-settings.md): Configure file storage providers.
- [GET SMTP Settings](https://docs.zeplo.ai/docs/api-reference/settings/smtp-settings.md): Configure email SMTP settings.
- [GET Languages](https://docs.zeplo.ai/docs/api-reference/settings/languages.md): Manage platform languages and translations.
- [GET List Support Tickets](https://docs.zeplo.ai/docs/api-reference/support/list-tickets.md): Retrieve support tickets.
- [POST Create Ticket](https://docs.zeplo.ai/docs/api-reference/support/create-ticket.md): Create a new support ticket.
- [PUT Update Ticket](https://docs.zeplo.ai/docs/api-reference/support/update-ticket.md): Update a support ticket's status or details.
- [GET Ticket Messages](https://docs.zeplo.ai/docs/api-reference/support/ticket-messages.md): Manage messages within support tickets.
- [GET Sites & Widget](https://docs.zeplo.ai/docs/api-reference/knowledge-base/sites.md): Manage chat widget sites and configuration.
- [GET Training Sources](https://docs.zeplo.ai/docs/api-reference/knowledge-base/training-sources.md): Manage AI training data sources.
- [GET Q&A Pairs](https://docs.zeplo.ai/docs/api-reference/knowledge-base/qa-pairs.md): Manage question-answer pairs for AI training.
- [GET Widget Chat](https://docs.zeplo.ai/docs/api-reference/knowledge-base/widget.md): Chat widget public API endpoints.
- [GET List Users](https://docs.zeplo.ai/docs/api-reference/users/list-users.md): Retrieve platform users (admin).
- [POST Create User](https://docs.zeplo.ai/docs/api-reference/users/create-user.md): Register a new user.
- [PUT Update User](https://docs.zeplo.ai/docs/api-reference/users/update-user.md): Update user details and status.
- [DELETE Delete User](https://docs.zeplo.ai/docs/api-reference/users/delete-user.md): Delete a user account.

## OpenAPI Specs

- [openapi](https://docs.zeplo.ai/openapi.yaml)

## Optional

- [Dashboard](https://app.zeplo.ai)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.