API reference
WhatsApp API reference by endpoint
Every endpoint of the ZapZap REST API on its own page, with method, path, parameters, request examples in curl, Node.js and Python, and a sample response. 153 endpoints in 17 categories.
Authentication
Every request uses the x-api-key and x-api-secret headers, available in the dashboard under Settings and API.
Base URL
Instance operations use /api/v1/{instanceId}/...; account and instance management uses /api/v1/instances, /api/v1/account and similar.
Paths are relative to https://api.zapzapapi.com/api/v1. Replace {instanceId} with the instance ID shown in the dashboard.
Account and Instances
- GET/accountAccount Details
- GET/instancesList Instances
- POST/instancesCreate Instance
- GET/instances/costCreation Cost
- DELETE/instances/{id}Delete Instance
- GET/instances/{id}Instance Details
- PUT/instances/{id}Update Instance
- GET/instances/{id}/qrcodeInstance QR Code
- GET/instances/{id}/webhookView Webhook
- PUT/instances/{id}/webhookConfigure Webhook
- POST/instances/{id}/webhook/testTest Webhook
- GET/{instanceId}/instance/wa_messages_limitsNew Conversation Limits (WhatsApp)
Send Messages
- POST/{instanceId}/send/carouselSend Carousel
- POST/{instanceId}/send/contactSend Contact (vCard)
- POST/{instanceId}/send/locationSend Location
- POST/{instanceId}/send/location-buttonRequest Location
- POST/{instanceId}/send/mediaSend Media
- POST/{instanceId}/send/buttonsSend Reply Buttons
- POST/{instanceId}/send/listSend Options List
- POST/{instanceId}/send/pollSend Poll
- POST/{instanceId}/send/pix-buttonSend PIX Button
- POST/{instanceId}/send/request-paymentRequest Payment
- POST/{instanceId}/send/statusSend Status / Story
- POST/{instanceId}/send/textSend Text
Conversations
- POST/{instanceId}/chat/archiveArchive Chat
- POST/{instanceId}/chat/blockBlock / Unblock Contact
- GET/{instanceId}/chat/blocklistBlocked List
- POST/{instanceId}/chat/deleteDelete Chat
- POST/{instanceId}/chat/findSearch Chats
- POST/{instanceId}/chat/muteMute Chat
- POST/{instanceId}/chat/notesView Chat Notes
- POST/{instanceId}/chat/notes/editEdit Chat Notes
- POST/{instanceId}/chat/notes/refreshReload Notes
- POST/{instanceId}/chat/pinPin / Unpin Chat
- POST/{instanceId}/chat/readMark Chat as Read
- POST/{instanceId}/message/deleteDelete Message
- POST/{instanceId}/message/downloadDownload Media
- POST/{instanceId}/message/editEdit Message
- POST/{instanceId}/message/findMessage History
- POST/{instanceId}/message/history-syncSync History
- POST/{instanceId}/message/markreadMark as Read
- POST/{instanceId}/message/presenceTyping Indicator...
- POST/{instanceId}/message/reactReact with Emoji
- POST/{instanceId}/chat/ephemeralDisappearing Messages (private chat)
Contacts and Profile
- POST/{instanceId}/chat/checkCheck Number
- POST/{instanceId}/chat/detailsContact Details
- POST/{instanceId}/contact/addAdd Contact
- POST/{instanceId}/contact/removeRemove Contact
- GET/{instanceId}/contactsList Contacts (Fast)
- POST/{instanceId}/contacts/listList Contacts
- POST/{instanceId}/profile/imageChange Photo
- POST/{instanceId}/profile/nameChange Name
Groups
- POST/{instanceId}/community/createCreate Community
- POST/{instanceId}/community/editgroupsManage Community Groups
- POST/{instanceId}/group/createCreate Group
- POST/{instanceId}/group/infoGroup Information
- POST/{instanceId}/group/inviteInfoInfo from Invite
- POST/{instanceId}/group/joinJoin Group via Link
- POST/{instanceId}/group/leaveLeave Group
- GET/{instanceId}/group/listList Groups
- POST/{instanceId}/group/listSearch Groups
- POST/{instanceId}/group/resetInviteCodeReset Invite Code
- POST/{instanceId}/group/updateAnnounceAdmins-Only Mode
- POST/{instanceId}/group/updateDescriptionChange Group Description
- POST/{instanceId}/group/updateImageChange Group Photo
- POST/{instanceId}/group/updateLockedLock Group Editing
- POST/{instanceId}/group/updateNameRename Group
- POST/{instanceId}/group/updateParticipantsManage Participants
- POST/{instanceId}/group/ephemeralDisappearing Messages (group)
- POST/{instanceId}/group/updateJoinApprovalRequire Approval to Join
- POST/{instanceId}/group/updateMemberAddModeWho Can Add Members
Newsletters and Channels
- POST/{instanceId}/newsletter/admin/acceptAccept Admin Invite
- POST/{instanceId}/newsletter/admin/inviteInvite Channel Admin
- POST/{instanceId}/newsletter/admin/removeRemove Channel Admin
- POST/{instanceId}/newsletter/admin/revokeRevoke Admin Invite
- POST/{instanceId}/newsletter/createCreate Channel
- POST/{instanceId}/newsletter/deleteDelete Channel
- POST/{instanceId}/newsletter/descriptionChange Channel Description
- POST/{instanceId}/newsletter/followFollow Channel
- POST/{instanceId}/newsletter/infoChannel Info
- POST/{instanceId}/newsletter/linkFind Channel by Link
- GET/{instanceId}/newsletter/listList Channels
- POST/{instanceId}/newsletter/messagesChannel Messages
- POST/{instanceId}/newsletter/messages/deleteDelete Channel Message
- POST/{instanceId}/newsletter/messages/editEdit Channel Message
- POST/{instanceId}/newsletter/muteMute Channel
- POST/{instanceId}/newsletter/nameChange Channel Name
- POST/{instanceId}/newsletter/owner/transferTransfer Channel Ownership
- POST/{instanceId}/newsletter/pictureChange Channel Photo
- POST/{instanceId}/newsletter/reactionReact to Channel Post
- POST/{instanceId}/newsletter/searchSearch Channels
- POST/{instanceId}/newsletter/settingsChannel Settings
- POST/{instanceId}/newsletter/subscribeSubscribe to Channel Updates
- POST/{instanceId}/newsletter/unfollowUnfollow
- POST/{instanceId}/newsletter/unmuteUnmute Channel
- POST/{instanceId}/newsletter/updatesChannel Updates
- POST/{instanceId}/newsletter/viewedMark as Viewed
Campaigns
- POST/{instanceId}/sender/advancedSend Batch Campaign
- DELETE/{instanceId}/sender/clearallClear Entire Queue
- POST/{instanceId}/sender/cleardoneClear Completed Campaigns
- POST/{instanceId}/sender/editControl Campaign
- GET/{instanceId}/sender/listfoldersList Campaigns
- POST/{instanceId}/sender/listmessagesList Campaign Messages
- POST/{instanceId}/sender/simpleSend Simple Message
WhatsApp Business
- POST/{instanceId}/business/catalog/deleteDelete Catalog Product
- POST/{instanceId}/business/catalog/hideHide Catalog Product
- POST/{instanceId}/business/catalog/infoProduct Info
- POST/{instanceId}/business/catalog/listList Product Catalog
- POST/{instanceId}/business/catalog/showShow Catalog Product
- GET/{instanceId}/business/get/categoriesList Business Categories
- POST/{instanceId}/business/get/profileView Business Profile
- POST/{instanceId}/business/update/profileUpdate Business Profile
Settings
- POST/{instanceId}/chat/labelsApply Label to Chat
- POST/{instanceId}/instance/connectConnect Instance
- POST/{instanceId}/instance/disconnectDisconnect Instance
- POST/{instanceId}/instance/presencePresence Status
- GET/{instanceId}/instance/privacyView Privacy
- POST/{instanceId}/instance/privacyChange Privacy
- GET/{instanceId}/instance/proxyView Proxy
- POST/{instanceId}/instance/proxyConfigure Proxy
- POST/{instanceId}/instance/resetRestart Instance
- GET/{instanceId}/instance/statusInstance Info & Status
- POST/{instanceId}/instance/updateDelaySettingsConfigure Delay
- POST/{instanceId}/instance/updateInstanceNameRename Instance
- POST/{instanceId}/label/editCreate / Edit Label
- GET/{instanceId}/labelsList Labels
- POST/{instanceId}/labels/refreshReload Labels
- POST/{instanceId}/quickreply/editCreate / Edit Quick Reply
- GET/{instanceId}/quickreply/showallList Quick Replies
Webhooks and Events
Async Queue
Chatbot and AI
- POST/{instanceId}/agent/editCreate/Edit AI Agent
- GET/{instanceId}/agent/listList AI Agents
- POST/{instanceId}/function/editCreate/Edit API Function
- GET/{instanceId}/function/listList API Functions
- POST/{instanceId}/knowledge/editCreate/Edit Knowledge
- GET/{instanceId}/knowledge/listList Knowledge
- POST/{instanceId}/trigger/editCreate/Edit Trigger
- GET/{instanceId}/trigger/listList Triggers
CRM and Leads
Chatwoot Integration
Get your API keys
Create your account, connect a number in minutes and start using the API. R$15 per active number/month, with a welcome credit when you create the account, subject to the current campaign.