Full reference
All 70 operations across 10 groups. Identical in Make and n8n.
Instance (5)
Operate your connected number — pair it with a QR code, check the connection state, set presence, restart or log out.
| Operation | Endpoint | Parameters |
|---|---|---|
| Restart Instance Restart the instance process restart | POST/instance/restart/{instance} |
|
| Connect Instance Connect the instance and return its pairing QR code connect | GET/instance/connect/{instance} |
|
| Get Connection State Current connection state of the instance connectionState | GET/instance/connectionState/{instance} |
|
| Set Presence Set the instance presence, such as available or unavailable setPresence | POST/instance/setPresence/{instance} |
|
| Log Out Instance Log the instance out of WhatsApp without deleting it logout | DELETE/instance/logout/{instance} |
|
Send Message (13)
Every outbound message type: text, media, audio, stickers, locations, contacts, reactions, polls, lists, buttons and Business templates.
| Operation | Endpoint | Parameters |
|---|---|---|
| Send Template Send an approved WhatsApp Business template sendTemplate | POST/message/sendTemplate/{instance} |
|
| Send Text Send a plain text message sendText | POST/message/sendText/{instance} |
|
| Send Media Send an image, video or document by URL or base64 sendMedia | POST/message/sendMedia/{instance} |
|
| Send Video Note Send a round play-through video note sendPtv | POST/message/sendPtv/{instance} |
|
| Send Audio Send a voice note sendWhatsAppAudio | POST/message/sendWhatsAppAudio/{instance} |
|
| Send Status Post a status update to the status feed sendStatus | POST/message/sendStatus/{instance} |
|
| Send Sticker Send a sticker sendSticker | POST/message/sendSticker/{instance} |
|
| Send Location Send a geographic location sendLocation | POST/message/sendLocation/{instance} |
|
| Send Contact Send one or more contact cards sendContact | POST/message/sendContact/{instance} |
|
| Send Reaction React to a message with an emoji sendReaction | POST/message/sendReaction/{instance} |
|
| Send Poll Send a poll with selectable options sendPoll | POST/message/sendPoll/{instance} |
|
| Send List Send an interactive list menu sendList | POST/message/sendList/{instance} |
|
| Send Buttons Send a message with interactive buttons sendButtons | POST/message/sendButtons/{instance} |
|
Call (1)
Ring a contact with a call offer.
| Operation | Endpoint | Parameters |
|---|---|---|
| Offer Call Ring a contact with a call offer offer | POST/call/offer/{instance} |
|
Chat (23)
Read and act on conversations — find chats, contacts and messages, mark as read, archive, block, and manage the profile.
| Operation | Endpoint | Parameters |
|---|---|---|
| Check WhatsApp Numbers Check which of the given numbers are registered on WhatsApp whatsappNumbers | POST/chat/whatsappNumbers/{instance} |
|
| Mark Message as Read Mark one or more messages as read markMessageAsRead | POST/chat/markMessageAsRead/{instance} |
|
| Archive Chat Archive or unarchive a chat archiveChat | POST/chat/archiveChat/{instance} |
|
| Mark Chat as Unread Mark a chat as unread markChatUnread | POST/chat/markChatUnread/{instance} |
|
| Delete Message for Everyone Revoke a sent message for all participants deleteMessageForEveryone | DELETE/chat/deleteMessageForEveryone/{instance} |
|
| Get Profile Picture URL Profile picture URL for a contact fetchProfilePictureUrl | POST/chat/fetchProfilePictureUrl/{instance} |
|
| Download Media Download a media message and return it as base64 getBase64FromMediaMessage | POST/chat/getBase64FromMediaMessage/{instance} |
|
| Update Message Edit the text of a message already sent updateMessage | POST/chat/updateMessage/{instance} |
|
| Send Chat Presence Show a typing or recording indicator in a chat sendPresence | POST/chat/sendPresence/{instance} |
|
| Update Block Status Block or unblock a contact updateBlockStatus | POST/chat/updateBlockStatus/{instance} |
|
| Find Contacts Search stored contacts findContacts · returns a list | POST/chat/findContacts/{instance} |
|
| Find Messages Search stored messages findMessages · returns a list | POST/chat/findMessages/{instance} |
|
| Find Status Messages Search status-feed messages findStatusMessage · returns a list | POST/chat/findStatusMessage/{instance} |
|
| Find Chats List stored chats findChats · returns a list | POST/chat/findChats/{instance} |
|
| Get Chat by JID Fetch one chat by its remote JID findChatByRemoteJid | GET/chat/findChatByRemoteJid/{instance} |
|
| Get Business Profile Business profile of a WhatsApp Business contact fetchBusinessProfile | POST/chat/fetchBusinessProfile/{instance} |
|
| Get Profile Profile details of a contact fetchProfile | POST/chat/fetchProfile/{instance} |
|
| Update Profile Name Change the instance display name updateProfileName | POST/chat/updateProfileName/{instance} |
|
| Update Profile Status Change the instance status text updateProfileStatus | POST/chat/updateProfileStatus/{instance} |
|
| Update Profile Picture Change the instance profile picture updateProfilePicture | POST/chat/updateProfilePicture/{instance} |
|
| Remove Profile Picture Remove the instance profile picture removeProfilePicture | DELETE/chat/removeProfilePicture/{instance} |
|
| Get Privacy Settings Current privacy settings for the instance fetchPrivacySettings | GET/chat/fetchPrivacySettings/{instance} |
|
| Update Privacy Settings Change the instance privacy settings updatePrivacySettings | POST/chat/updatePrivacySettings/{instance} |
|
Business (2)
Read a WhatsApp Business product catalog and its collections.
| Operation | Endpoint | Parameters |
|---|---|---|
| Get Catalog Product catalog of a WhatsApp Business account getCatalog | POST/business/getCatalog/{instance} |
|
| Get Collections Catalog collections of a WhatsApp Business account getCollections | POST/business/getCollections/{instance} |
|
Group (16)
Create groups and administer them: participants, invites, subject and picture, and disappearing messages.
| Operation | Endpoint | Parameters |
|---|---|---|
| Create Group Create a group and add the given participants createGroup | POST/group/create/{instance} |
|
| Update Group Subject Rename a group updateGroupSubject | POST/group/updateGroupSubject/{instance} |
|
| Update Group Picture Change a group picture updateGroupPicture | POST/group/updateGroupPicture/{instance} |
|
| Update Group Description Change a group description updateGroupDescription | POST/group/updateGroupDescription/{instance} |
|
| Get Group Info Metadata for one group findGroupInfos | GET/group/findGroupInfos/{instance} |
|
| List Groups List every group the instance belongs to fetchAllGroups · returns a list | GET/group/fetchAllGroups/{instance} |
|
| List Group Participants List the members of a group participants · returns a list | GET/group/participants/{instance} |
|
| Get Group Invite Code Current invite code for a group inviteCode | GET/group/inviteCode/{instance} |
|
| Get Group Invite Info Inspect a group invite before accepting it inviteInfo | GET/group/inviteInfo/{instance} |
|
| Accept Group Invite Join a group using an invite code acceptInviteCode | GET/group/acceptInviteCode/{instance} |
|
| Send Group Invite Send a group invite link to numbers sendInvite | POST/group/sendInvite/{instance} |
|
| Revoke Group Invite Code Invalidate the current invite code and issue a new one revokeInviteCode | POST/group/revokeInviteCode/{instance} |
|
| Update Group Participant Add, remove, promote or demote group members updateParticipant | POST/group/updateParticipant/{instance} |
|
| Update Group Setting Change who may post or edit group info updateSetting | POST/group/updateSetting/{instance} |
|
| Toggle Disappearing Messages Set the disappearing-message timer for a group toggleEphemeral | POST/group/toggleEphemeral/{instance} |
|
| Leave Group Leave a group leaveGroup | DELETE/group/leaveGroup/{instance} |
|
Template (4)
WhatsApp Business message templates — create, edit, delete and list.
| Operation | Endpoint | Parameters |
|---|---|---|
| Create Template Create a WhatsApp Business message template createTemplate | POST/template/create/{instance} |
|
| Edit Template Edit an existing message template editTemplate | POST/template/edit/{instance} |
|
| Delete Template Delete a message template deleteTemplate | DELETE/template/delete/{instance} |
|
| List Templates List the message templates on the account findTemplate · returns a list | GET/template/find/{instance} |
|
Setting (2)
Instance behaviour — call rejection, read receipts, group handling and history sync.
| Operation | Endpoint | Parameters |
|---|---|---|
| Set Setting POST /settings/set/{instance} setSetting | POST/settings/set/{instance} |
|
| Find Setting GET /settings/find/{instance} findSetting · returns a list | GET/settings/find/{instance} |
|
Proxy (2)
Route an instance through an HTTP proxy.
| Operation | Endpoint | Parameters |
|---|---|---|
| Set Proxy Route the instance through an HTTP proxy setProxy | POST/proxy/set/{instance} |
|
| Get Proxy Current proxy configuration findProxy | GET/proxy/find/{instance} |
|
Label (2)
List the chat labels on the account, and attach or detach them.
| Operation | Endpoint | Parameters |
|---|---|---|
| List Labels List the chat labels defined on the account findLabels · returns a list | GET/label/findLabels/{instance} |
|
| Add or Remove Label Attach a label to a chat or remove it handleLabel | POST/label/handleLabel/{instance} |
|