Explore all available tutorials and API use case examples with ready-to-use code examples 😎
Tutorials
- 💬 Send messages to phone numbers
- 💬 Send messages to group chats
- 💬 Send messages to channel 🆕
- 💬 Send messages from a CSV file 🆕
- 💬 Send messages from a Google Sheets document 🆕
- 📁 Send multimedia messages (images, videos, documents, files or audios)
- 💬 Include emojis in text messages
- 💬 Send location messages
- 💬 Send contacts
- 💬 Send URL links in text messages
- 💬 Send auto-expiring messages
- 💬 Send messages in real-time without queueing
- 💬 Send messages through a specific WhatsApp number/device
- 💬 Send messages on behalf of a chat agent
- 💬 Send messages replying to a specific message
- 💬 Send dynamic buttons message (
deprecated) - 💬 Send dynamic list message (
deprecated) - 📝 How to use template variables
- 📝 How to format text with styling in messages
- ✅ Check if a phone number exists in WhatsApp and can receive messages
Chatbots 🔥
- 🤖 Create a custom chat bot using the API + Webhooks 🆕
- 🤖 Create a ChatGPT-powered AI chatbot assistant for your business 🆕
Integrations
- ✅ Connect and automate WhatsApp with 1000+ third-party apps and CRMs using Make/Integromat
- ✅ Learn how to use webhooks
- ✅ Import contacts from Hubspot CRM
- ✅ Export a document as CSV to later import it
- ✅ Play and debug the API using Postman
- ✅ Zapier integration
- ✅ Make.com integration
API use case examples
Messages
- 💬 Send message to phone number
- 💬 Send message to group
- 💬 Send message to channel
- 💬 Send image message
- 💬 Send video message
- 💬 Send audio message
- 💬 Send document PDF media message
- 💬 Send media file from uploaded file
- 💬 Send scheduled message
- 💬 Send scheduled message to group
- 💬 Send scheduled message to channel
- 💬 Send image to groups
- 💬 Send audio to groups
- 💬 Send video to groups
- 💬 Send image to channels
- 💬 Send video to channels
- 💬 Send GIF
- 💬 Send GIF to a group chat
- 💬 Send poll to a user
- 💬 Send poll to a group
- 💬 Send poll to a channel
- 💬 Send poll with limited to a single vote
- 💬 Send votes on an existing user poll
- 💬 Send votes on an existing group poll
- 💬 Remove votes on an existing user poll
- 💬 Send meeting event video call to a group
- 💬 Send meeting event voice call to a group
- 💬 Confirm attendance to meeting event
- 💬 Reject attendance to meeting event
- 💬 Mention group participants in a message
- 💬 Send message simulating user typing chat status
- 💬 Send location message using coordinates
- 💬 Send location message using an address
- 💬 Send dynamic reply buttons message (
deprecated) - 💬 Send actions reply buttons message (
deprecated) - 💬 Send a list of options to ask the user to select from (
deprecated) - 💬 Send message with emojis
- 💬 Send message with template variables
- 💬 Send message with formatted text
- 💬 Send message with URL links
- 💬 Send contacts
- 💬 Reply to another message
- 💬 Forward message to another chat
- 💬 Reply to a buttons or list message 🆕
- 💬 Send scheduled message at a specific date
- 💬 Send auto-expiring messages at a specific date
- 💬 Send message through a specific device/number
- 💬 Send message in real-time with no queueing
- 💬 Send product catalog message
- 💬 Send message reaction
- 💬 Remove message reaction
- 💬 Send message in strict queue order
- 💬 Send message with delivery priority
- 💬 Send message on behalf of an agent
- 💬 Send message and assign the chat to an agent
- 💬 Send message and unassign the chat from an agent
- 💬 Send message and resolve chat automatically
- 💬 Send message and add labels to chat
- 💬 Send message and remove labels from chat
- 💬 Send message and add metadata to the chat's contact
- 💬 Send message and remove metadata from the chat's contact
- 💬 Send message with special text format
- 💬 Send message with emojis 😀 😉 👏
- 💬 Send message with a custom reference ID for better integration and message tracking
- 💬 Edit message
- 💬 Delete message
Files
- 📁 Upload file from URL
- 📁 Search uploaded files
- 📁 Search received files
- 📁 Get uploaded file information
- 📁 Get received file information
- 📁 Delete uploaded file
- 📁 Delete multiple uploaded files
- 📁 Download uploaded file content
- 📁 Download received file content
Contacts
- 👥 Search contacts
- 👥 Search contacts by metadata
- 👥 Create new contact
- 👥 Update existing contact (chat only)
- 👥 Update contact metadata
- 👥 Exclude contact from receiving campaigns
- 👥 Subscribe contact to receive campaigns
- 👥 Block contact
- 👥 Unblock contact
WhatsApp Status (stories) 🆕
- 👤 Update WhatsApp status with text and links
- 👤 Update WhatsApp status with image
- 👤 Update WhatsApp status with video
- 👤 Schedule WhatsApp status update
- 👤 Get WhatsApp user status history
- 👤 Get your own WhatsApp number user status history
- 👤 Get scheduled WhatsApp user status to be published
- 👤 Delete all WhatsApp user status published
WhatsApp profile
- 👤 Get WhatsApp profile information
- 👤 Update WhatsApp profile information
- 👤 Update WhatsApp profile image
Groups
- 👨👩👦👦 Create new group chat
- 👨👩👦👦 Get list of available group chats
- 👨👩👦👦 Update group information and permissions
- 👨👩👦👦 Update group image
- 👨👩👦👦 Get group participants
- 👨👩👦👦 Add participants to a group
- 👨👩👦👦 Remove participants from a group
- 👨👩👦👦 Promote participants as administrators in a group chat
- 👨👩👦👦 Demote participants as administrators in a group chat
- 👨👩👦👦 Get pending approvals for new group members
- 👨👩👦👦 Approve group members by phone number
- 👨👩👦👦 Approve all pending group members
- 👨👩👦👦 Reject group members by phone number
- 👨👩👦👦 Reject all pending group members
- 👨👩👦👦 Get group invite code and URL
- 👨👩👦👦 Revoke group invite code
- 👨👩👦👦 Join group by invitation code
- 👨👩👦👦 Leave group
Campaigns 🆕
- 📣 Create new campaign
- 📣 List campaigns
- 📣 Get campaign by ID
- 📣 Update campaign
- 📣 Start a campaign
- 📣 Stop a campaign
- 📣 Delete a campaign
Channels 🆕
- 📢 Create new channel
- 📢 List active channels
- 📢 Search channels
- 📢 Update channel
- 📢 Update channel image
- 📢 Follow channel
- 📢 Unfollow channel
- 📢 Get channel messages
- 📢 Remove channel
Chats
- 📥 Search chats
- 📥 Get a specific chat by ID
- 🏷️ Set chat labels
- 🏷️ Update chat labels
- 🏷️ Remove chat labels
- 📥 Assign chat to an agent
- 📥 Assign chat to a department
- 📥 Assign chat to both department and agent
- 📥 Unassign chat from agent
- 📥 Set chat status as resolved
- 📥 Archive chat
- 📥 Unarchive chat
- 📥 Read one or multiple chats
- 📥 Mark chat as unread
- 📥 Get list messages for a specific chat
- 📥 Get specific chat message by ID
- 📥 Send typing state in a chat
- 📥 Send voice recording state in a chat
- 📥 Send typing state in a group
- 📥 Stop typing state in a chat
- 📃 Create a private note in a chat
- 📥 Bulk resolve multiple chats at once
- 📥 Bulk assign to agent multiple chats at once
- 📥 Bulk assign to a department multiple chats at once
- 🗑️ Delete chat by WhatsApp ID
- 🗑️ Delete multiple chats at once
Labels
- 🏷️ Get available labels
- 🏷️ Create label
- 🏷️ Update label
- 🏷️ Delete label
- 🏷️ Update chat labels
Messages queue (outbound only)
- 🕒 Get messages queue information
- 🕒 Pause messages queue processing
- 🕒 Resume messages queue processing
- 🕒 Freeze messages queue processing
- 🕒 Reject adding more messages to the queue
- 🕒 Transfer queued message to a different number
- 🕒 Delete all queued messages
- 🕒 Delete queued messages by date range
- 🕒 Delete queued messages by target phone numbers
- 🕒 Delete queued messages by target group chats
- 🕒 Delete queued messages by message IDs
Team members
- 👥 Get team users available
- 👥 Get team users available per Whatsapp number
- 👥 Create user
- 👥 Update user
- 👥 Delete user
- 👥 Grant user access to WhatsApp number
- 👥 Revoke user access from WhatsApp number
Team departments
Manage WhatsApp numbers
- 📞 Get WhatsApp numbers available
- 📞 Get WhatsApp number by device ID
- 📞 Create new WhatsApp number virtual device
- 📞 Update WhatsApp number configuration
- 📞 Update WhatsApp number subscription plan
- 🗑️ Delete number and cancel the subscription
WhatsApp number session management
- ⚙️ Get WhatsApp session status
- ⚙️ Get QR image for WhatsApp number pairing
- ⚙️ Connect number via authentication code (instead of QR)
- ⚙️ Recreate WhatsApp number session
- ⚙️ Reboot WhatsApp number session
- ⚙️ Synchronize WhatsApp session
Business Catalog
- 🛒 Get the Business catalog of your connected number
- 🛒 Query the Business catalog of any WhatsApp number
Numbers validation
Meeting Links 🆕
- 📞 Create a new meeting voice link
- 📞 Create a new meeting video link
- 📞 Get meeting links available
- 📞 Delete meeting links
Additional resources
API documentation
Explore the detailed API documentation here.
API live tester with dozens of examples
Explore, play and test API in real-time with 80+ use case examples and generate the ready-to-use code in 15+ programming languages.
Live code API testing in JavaScript
Live code, test and debug the API with ready-to-use examples using JavaScript in the server with Node.js.