# Wappfy

> WhatsApp API Platform — Send messages, manage instances, and build integrations.

## Docs

- [Check Webshare API health](https://docs.wappfy.io/api-reference/admin/check-webshare-api-health.md): Checks the health of the Webshare proxy API. Requires admin role.
- [Get platform statistics](https://docs.wappfy.io/api-reference/admin/get-platform-statistics.md): Returns platform-wide statistics including user count, instance count, and message volume. Requires admin role.
- [Get proxy country distribution](https://docs.wappfy.io/api-reference/admin/get-proxy-country-distribution.md): Returns the geographic distribution of active proxies by country. Requires admin role.
- [Get proxy replacement statistics](https://docs.wappfy.io/api-reference/admin/get-proxy-replacement-statistics.md): Returns proxy replacement statistics and current distribution. Requires admin role.
- [Get user detail (admin)](https://docs.wappfy.io/api-reference/admin/get-user-detail-admin.md): Returns detailed information about a specific user. Requires admin role.
- [List all users (admin)](https://docs.wappfy.io/api-reference/admin/list-all-users-admin.md): Returns a paginated list of all registered users. Requires admin role.
- [Sync WAHA instances with database](https://docs.wappfy.io/api-reference/admin/sync-waha-instances-with-database.md): Synchronizes WAHA sessions with the database. Creates missing DB records for orphan sessions and cleans up stale entries. Requires admin role.
- [Update user (admin)](https://docs.wappfy.io/api-reference/admin/update-user-admin.md): Updates a user's role, active status, plan, or display name. Requires admin role.
- [Create a channel](https://docs.wappfy.io/api-reference/channels/create-a-channel.md): Creates a new WhatsApp Channel with the given name and optional description.
- [Delete a channel (GOWS: not supported)](https://docs.wappfy.io/api-reference/channels/delete-a-channel-gows:-not-supported.md): Deletes a WhatsApp Channel. Note: this operation is not supported on the GOWS engine and will return 501.
- [List channels](https://docs.wappfy.io/api-reference/channels/list-channels.md): Returns all WhatsApp Channels the instance follows or has created.
- [Delete a message](https://docs.wappfy.io/api-reference/chats/delete-a-message.md): Deletes a specific message from a chat. The message is deleted for everyone if you are the sender.
- [Get messages from a chat](https://docs.wappfy.io/api-reference/chats/get-messages-from-a-chat.md): Retrieves message history from a specific chat. Messages are returned in reverse chronological order. Set downloadMedia=true to include base64 media content.
- [List chats](https://docs.wappfy.io/api-reference/chats/list-chats.md): Returns a list of recent chats for the instance, ordered by last activity. Use limit/offset for pagination.
- [Mark chat as read](https://docs.wappfy.io/api-reference/chats/mark-chat-as-read.md): Marks all messages in a chat as read (sends blue double-check). This also clears the unread counter on the sender's device.
- [Start typing indicator](https://docs.wappfy.io/api-reference/chats/start-typing-indicator.md): Shows the 'typing...' indicator in the chat. The indicator automatically expires after a few seconds.
- [Stop typing indicator](https://docs.wappfy.io/api-reference/chats/stop-typing-indicator.md): Manually stops the typing indicator before it expires.
- [Check if a phone number exists on WhatsApp](https://docs.wappfy.io/api-reference/contacts/check-if-a-phone-number-exists-on-whatsapp.md): Checks if a phone number is registered on WhatsApp. Useful for validation before sending messages.
- [Get all contacts](https://docs.wappfy.io/api-reference/contacts/get-all-contacts.md): Returns all contacts from the instance's WhatsApp address book.
- [Get contact info](https://docs.wappfy.io/api-reference/contacts/get-contact-info.md): Returns detailed information about a specific contact.
- [Get contact profile picture URL](https://docs.wappfy.io/api-reference/contacts/get-contact-profile-picture-url.md): Returns the profile picture URL for a contact. Returns null if the contact has no picture or privacy settings block it.
- [Add participants to group](https://docs.wappfy.io/api-reference/groups/add-participants-to-group.md): Adds one or more participants to a group. You must be a group admin.
- [Create a group](https://docs.wappfy.io/api-reference/groups/create-a-group.md): Creates a new WhatsApp group with the specified name and participants.
- [Get group info](https://docs.wappfy.io/api-reference/groups/get-group-info.md): Returns detailed information about a group including subject, description, and participant list.
- [Get group invite code](https://docs.wappfy.io/api-reference/groups/get-group-invite-code.md): Generates or retrieves the group invite code. You must be a group admin.
- [Get group participants](https://docs.wappfy.io/api-reference/groups/get-group-participants.md): Returns the list of group participants with their admin roles.
- [Join a group via invite code](https://docs.wappfy.io/api-reference/groups/join-a-group-via-invite-code.md): Joins a group using an invite code or link.
- [Leave a group](https://docs.wappfy.io/api-reference/groups/leave-a-group.md): Leaves a WhatsApp group. This action cannot be undone.
- [List groups](https://docs.wappfy.io/api-reference/groups/list-groups.md): Returns all groups the instance is a member of.
- [Remove participants from group](https://docs.wappfy.io/api-reference/groups/remove-participants-from-group.md): Removes one or more participants from a group. You must be a group admin.
- [Update group subject/description/picture](https://docs.wappfy.io/api-reference/groups/update-group-subjectdescriptionpicture.md): Updates the group subject, description, or picture. Only admins can modify group settings.
- [Create a new instance](https://docs.wappfy.io/api-reference/instances/create-a-new-instance.md): Creates a new WhatsApp instance (WAHA or Cloud API). A WAHA session is automatically provisioned. Returns 403 if the user's plan limit is reached.
- [Delete instance](https://docs.wappfy.io/api-reference/instances/delete-instance.md): Permanently deletes an instance. For WAHA instances, the session is also cleaned up on the WAHA server.
- [Disconnect instance](https://docs.wappfy.io/api-reference/instances/disconnect-instance.md): Disconnects a WAHA instance from WhatsApp. The session data is preserved for reconnection.
- [Full logout and clear session](https://docs.wappfy.io/api-reference/instances/full-logout-and-clear-session.md): Performs a full logout and clears all session data. The instance will need to scan a new QR code to reconnect.
- [Get instance details](https://docs.wappfy.io/api-reference/instances/get-instance-details.md): Returns full details of a specific instance including connection status, phone number, and configuration. The instance must belong to the authenticated user.
- [Get live instance status](https://docs.wappfy.io/api-reference/instances/get-live-instance-status.md): Returns the live connection status of an instance by querying the WAHA server directly.
- [Get QR code for instance](https://docs.wappfy.io/api-reference/instances/get-qr-code-for-instance.md): Returns the current QR code for a WAHA instance. The QR code is only available when the instance status is 'scan_qr'. Cloud API instances do not use QR codes.
- [List user instances (paginated)](https://docs.wappfy.io/api-reference/instances/list-user-instances-paginated.md): Returns a paginated list of all WhatsApp instances belonging to the authenticated user. Includes connection status, phone number, and configuration for each instance.
- [Restart instance session](https://docs.wappfy.io/api-reference/instances/restart-instance-session.md): Restarts the WAHA session. Useful when the instance is in a stuck or failed state.
- [Start instance connection](https://docs.wappfy.io/api-reference/instances/start-instance-connection.md): Initiates the connection process for a WAHA instance (starts QR code generation). Cloud API instances connect via webhook configuration.
- [Sync profile picture from WhatsApp](https://docs.wappfy.io/api-reference/instances/sync-profile-picture-from-whatsapp.md): Fetches the latest profile picture from WhatsApp and updates it in the database.
- [Update instance settings](https://docs.wappfy.io/api-reference/instances/update-instance-settings.md): Updates instance settings such as name, webhook URL, or Cloud API credentials. Only the provided fields are modified.
- [Create a label](https://docs.wappfy.io/api-reference/labels/create-a-label.md): Creates a new label with the specified name and color.
- [Delete a label](https://docs.wappfy.io/api-reference/labels/delete-a-label.md): Permanently deletes a label. Chats previously tagged with this label will be untagged.
- [Get chats with a specific label](https://docs.wappfy.io/api-reference/labels/get-chats-with-a-specific-label.md): Returns all chats that have a specific label assigned.
- [Get labels for a chat](https://docs.wappfy.io/api-reference/labels/get-labels-for-a-chat.md): Returns all labels assigned to a specific chat.
- [List all labels](https://docs.wappfy.io/api-reference/labels/list-all-labels.md): Returns all labels configured for this WhatsApp Business instance.
- [Set labels for a chat](https://docs.wappfy.io/api-reference/labels/set-labels-for-a-chat.md): Replaces all labels on a chat with the specified label IDs.
- [Update a label](https://docs.wappfy.io/api-reference/labels/update-a-label.md): Updates an existing label's name or color.
- [Send a message via WhatsApp](https://docs.wappfy.io/api-reference/messages/send-a-message-via-whatsapp.md): Queues a message for delivery via WhatsApp. Supports 10 message types: text, image, video, audio, document, location, poll, contact, forward, and reaction. The message is processed asynchronously via BullMQ. Brazilian phone numbers are automatically retried with/without the 9th digit on failure.
- [Get current presence status](https://docs.wappfy.io/api-reference/presence/get-current-presence-status.md): Returns the current presence status (online/offline) of the instance.
- [Set presence (online/offline)](https://docs.wappfy.io/api-reference/presence/set-presence-onlineoffline.md): Sets the presence status of the instance. Use 'online' to appear active or 'offline' to go invisible.
- [Send a text status/story](https://docs.wappfy.io/api-reference/status/send-a-text-statusstory.md): Publishes a text status/story visible to all contacts. Supports custom background color and font.
- [Create a new webhook endpoint](https://docs.wappfy.io/api-reference/webhooks/create-a-new-webhook-endpoint.md): Creates a new webhook endpoint. Events define which notifications are sent to the URL. Use instance_id to scope to a specific instance.
- [Delete a webhook endpoint](https://docs.wappfy.io/api-reference/webhooks/delete-a-webhook-endpoint.md): Permanently deletes a webhook endpoint. Pending deliveries will be cancelled.
- [Get a webhook endpoint by ID](https://docs.wappfy.io/api-reference/webhooks/get-a-webhook-endpoint-by-id.md): Returns details of a specific webhook endpoint including URL, events, and retry configuration.
- [List all webhook endpoints for the current user](https://docs.wappfy.io/api-reference/webhooks/list-all-webhook-endpoints-for-the-current-user.md): Returns all webhook endpoints configured by the authenticated user.
- [List deliveries for a webhook endpoint](https://docs.wappfy.io/api-reference/webhooks/list-deliveries-for-a-webhook-endpoint.md): Returns the delivery history for a webhook endpoint. Useful for debugging failed deliveries.
- [Update a webhook endpoint](https://docs.wappfy.io/api-reference/webhooks/update-a-webhook-endpoint.md): Updates an existing webhook endpoint. All fields are optional - only provided fields are modified.
- [Authentication](https://docs.wappfy.io/authentication.md): How to authenticate with the Wappfy API using API keys or JWT tokens.
- [Contacts](https://docs.wappfy.io/guides/contacts.md): Look up contacts, verify phone numbers, and retrieve profile pictures before sending messages.
- [Groups](https://docs.wappfy.io/guides/groups.md): Create, manage, and interact with WhatsApp groups programmatically.
- [Managing Instances](https://docs.wappfy.io/guides/instances.md): Create, connect, and manage WhatsApp instances through their full lifecycle.
- [Labels](https://docs.wappfy.io/guides/labels.md): Create and manage WhatsApp Business labels to organize your chats and contacts.
- [Sending Messages](https://docs.wappfy.io/guides/sending-messages.md): Send text, media, locations, polls, contacts, reactions, and more through the Wappfy API.
- [Webhooks](https://docs.wappfy.io/guides/webhooks.md): Receive real-time notifications for messages, delivery events, and instance status changes.
- [Introduction](https://docs.wappfy.io/introduction.md): Welcome to the Wappfy API — a WhatsApp messaging platform for developers and businesses.
- [Quickstart](https://docs.wappfy.io/quickstart.md): Send your first WhatsApp message in under 5 minutes.
- [Rate Limits](https://docs.wappfy.io/rate-limits.md): API rate limiting policies and how to handle rate limit errors.
- [Response Format](https://docs.wappfy.io/response-format.md): How Wappfy API responses are structured — the standard envelope, pagination, and error format.

## OpenAPI Specs

- [openapi](https://docs.wappfy.io/openapi.json)
- [openapi-pt-BR](https://docs.wappfy.io/openapi-pt-BR.json)