Explore a complete set of ready-to-use API examples with a live testing editor.
Simply select one of the ready-to-use examples in the list and click on "Send request".
You can also obtain in just one click code snippets ready to run in 15+ different programming languages π
Messages
Send simple text messageSend multi-line text messageSend message to a groupSend message to channelSend media imageSend video messageSend media PDF messageSend audio as voice recordSend media message from uploaded fileSend GIFSend GIF to a groupSend poll message to a userSend poll to a groupSend poll to a channelSchedule a poll message in a groupSchedule a poll message in a channelSend votes on an existing user pollSend votes on an existing group pollRemove votes on an existing user pollSend meeting event video call to a groupSend meeting event voice call to a groupConfirm attendance to meeting eventReject attendance to meeting eventSend scheduled message at a specific date and timeSend scheduled message to a groupSend scheduled message to a channelSend mesage simulating typing statusSend image to groupSend audio to groupSend video to groupSend image to channelSend video to channelMention group participants in a messageSend message with dynamic reply buttonsSend message with action reply buttonsSend a list of items to select fromSend message with text formattingSend location message with coordinatesSend location message with addressSend message with emojis π π πSend message with template variablesSend message with URL linksSend contact card messageReply to messageForward message to another chatSelect reply in buttons or list messageSend message through a specific deviceSend message with a custom reference identifierSend product catalogSend message in real-time with no queueingSend messages in strict queue orderSend message with maximum retriesSend message with expiration timeSend message within a time and day rangeSend message reactionRemove message reactionEdit messageDelete messageSend message on behalf of an agentSend message on behalf of an agent and assign chatSend message and unassign chatSend message and resolve chatSend message and unresolve chatSend message and mark chat as unreadSend message and mark chat as readSend message and add chat labelsSend message and remove chat labelsSend message and add chat's contact metadataSend message and remove chat's contact metadataFiles
Upload file from remote URLSearch uploaded filesSearch received filesGet uploaded file informationGet received file informationDelete uploaded fileDelete multiple uploaded filesDownload uploaded file contentDownload received file contentWhatsApp Status
Search WhatsApp user status historyGet your own WhatsApp user status historyGet scheduled WhatsApp user status updatesUpdate WhatsApp Status with text and linkUpdate WhatsApp status with imageUpdate WhatsApp status with videoSchedule WhatsApp status updateSchedule a delayed WhatsApp status updateSchedule a delayed WhatsApp status update in strict publication orderDelete all WhatsApp user status currently activeCampaigns
Create campaignCreate campaign with unsubscribe featureList campaignsGet campaign by IDStart a campaignStop a campaignDelete a campaignUpdate a campaignMeeting links
Create a new voice meeting linkCreate a new video meeting linkGet meeting linksDelete meeting linksChats
Search chatsGet chat by IDList messages of a specific chatGet chat message by IDSend typing state in a chatSend voice recording state in a chatSend typing state in a groupStop typing state in a chatGet message delivery infoResolve multiple chats at onceAssign multiple chats at onceBulk assign to a department multiple chatsUpdate chat labelsUpsert chat labelsRemove chat labelsAssign chat to an agentAssign chat to a departmentAssign chat to both agent and departmentUnassign chat from agentSet chat status as resolvedSet chat status as pendingRead one or multiple chatsMark chat as unreadDelete chatDelete multiple chatsCreate a private note in a chatArchive chatUnarchive chatLabels
Update chat labelsUpsert chat labelsRemove chat labelsGet available labelsCreate new labelUpdate labelDelete labelContacts
Search contactsSearch contacts by metadataCreate new contactImport contactsUpdate contact with metadataPartially update contact metadataBlock contactsUnblock contactsGroups
Create a new groupGet list of available group chatsUpdate group information and permissionsUpdate group imageGet group participantsAdd participants to groupRemove participants from a groupPromote participants as admin in a groupDemote participants in a groupGet pending approvals for new group membersApprove group members by phone numberApprove all pending group membersReject group members by phone numberReject all pending group membersGet group invite code and URLRevoke group invite codeJoin group by invitation codeLeave groupChannels
Create a new channelGet list of available channelsSearch public WhatsApp channelsUpdate channel informationUpdate channel imageJoin channelUnfollow channelGet channel messagesWhatsApp profile
Get WhatsApp profile informationUpdate WhastApp profile informationGet WhastApp profile imageUpdate WhastApp profile imageTeam members
Get team users availableGet team users per WhatsApp numberCreate and invite user to your teamUpdate userDelete user and revoke access to your teamGrant user access to WhatsApp numberRevoke user access to WhatsApp numberMessages queue
Get messages queue informationPause messages queue processingResume messages queue processingFreeze messages queue processingReject adding more messages to the queueTransfer queued messages through another WhatsApp numberDelete all queued messagesDelete queued messages by date rangeDelete queued messages by target phone numbersDelete queued messages by target group chatsDelete queued messages by target message IDsCatalog
Get the Business catalog of your connected numberQuery the WhatsApp Business catalog of any numberNumbers validation
Check if a phone number exists in WhatsAppValidate and normalize a list of phone numbersAPI documentation
For more details about the API, explore the documentation here.
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.