# WhatsTeam API — endpoint index > Version 1.0.0. Base URL: https://api.whats.team/v1 > For clean Markdown of any endpoint, append `.md` to its docs URL. > For the full endpoint index, see https://app.whats.team/docs/md/index.md. > To connect an AI client (Claude Code, Cursor, …), use the MCP server at https://api.whats.team/mcp. > > Reference: https://app.whats.team/docs ## Authentication - `Token` header (required) - `Authorization` header (required) ## Endpoints ### Webhooks - [Get webhooks](https://app.whats.team/docs/md/getWebhooks.md) — `GET /webhooks` - [Register webhook](https://app.whats.team/docs/md/createWebhook.md) — `POST /webhooks` - [Get webhook logs](https://app.whats.team/docs/md/getWebhookLogs.md) — `GET /webhooks/{webhookId}/logs` - [Enable webhook](https://app.whats.team/docs/md/enableWebhook.md) — `POST /webhooks/{webhookId}/enable` - [Get webhook details](https://app.whats.team/docs/md/getWebhook.md) — `GET /webhooks/{webhookId}` - [Update webhook](https://app.whats.team/docs/md/updateWebhook.md) — `PATCH /webhooks/{webhookId}` - [Delete webhook](https://app.whats.team/docs/md/deleteWebhook.md) — `DELETE /webhooks/{webhookId}` ### Templates - [Upload template header media](https://app.whats.team/docs/md/uploadTemplateMedia.md) — `POST /waba/templates/media` - [List templates](https://app.whats.team/docs/md/getTemplates.md) — `GET /waba/templates` - [Create or update a template](https://app.whats.team/docs/md/createOrUpdateTemplate.md) — `POST /waba/templates` - [Delete templates](https://app.whats.team/docs/md/deleteTemplates.md) — `DELETE /waba/templates` ### Templates Pricing - [Get messaging prices](https://app.whats.team/docs/md/getWabaPrices.md) — `GET /waba/prices` - [Calculate messaging costs](https://app.whats.team/docs/md/calculateWabaCosts.md) — `POST /waba/prices` ### Flows - [List the responses to a WhatsApp Form](https://app.whats.team/docs/md/getFlowResponses.md) — `GET /waba/flows/responses` - [List WhatsApp Flows](https://app.whats.team/docs/md/getFlows.md) — `GET /waba/flows` ### Verify - [Number exists](https://app.whats.team/docs/md/verifyNumber.md) — `POST /verify/number` - [Validate username](https://app.whats.team/docs/md/validateUsername.md) — `POST /validate/username` - [Validate numbers (Validate alias)](https://app.whats.team/docs/md/validateNumber.md) — `POST /validate/number` - [Number exists](https://app.whats.team/docs/md/verifyNumber.md) — `POST /numbers/exists` ### Team Members - [Get users](https://app.whats.team/docs/md/getTeamUsers.md) — `GET /team` - [Update user](https://app.whats.team/docs/md/updateTeamUser.md) — `PATCH /team` - [Delete users](https://app.whats.team/docs/md/deleteUsers.md) — `DELETE /team` - [Get users per number](https://app.whats.team/docs/md/getDeviceTeamMembers.md) — `GET /devices/{deviceId}/team` - [Create user](https://app.whats.team/docs/md/createDeviceUser.md) — `POST /devices/{deviceId}/team` - [Grant user access](https://app.whats.team/docs/md/grantDeviceUserAccess.md) — `PATCH /devices/{deviceId}/team` - [Revoke user access](https://app.whats.team/docs/md/revokeDeviceUserAccess.md) — `DELETE /devices/{deviceId}/team` ### Pipeline - [Get pipelines](https://app.whats.team/docs/md/getPipelines.md) — `GET /pipelines` - [Create pipeline](https://app.whats.team/docs/md/createPipeline.md) — `POST /pipelines` - [Get pipeline](https://app.whats.team/docs/md/getPipeline.md) — `GET /pipelines/{pipelineId}` - [Update pipeline](https://app.whats.team/docs/md/updatePipeline.md) — `PATCH /pipelines/{pipelineId}` - [Delete pipeline](https://app.whats.team/docs/md/deletePipeline.md) — `DELETE /pipelines/{pipelineId}` ### Numbers - [Validate numbers](https://app.whats.team/docs/md/validateNumbers.md) — `POST /numbers/validate` ### Messages - [Search messages](https://app.whats.team/docs/md/searchMessages.md) — `GET /messages` - [Send message](https://app.whats.team/docs/md/createMessage.md) — `POST /messages` - [Get message by ID](https://app.whats.team/docs/md/getMessage.md) — `GET /messages/{messageId}` - [Update queued message](https://app.whats.team/docs/md/updateMessage.md) — `PATCH /messages/{messageId}` - [Delete message](https://app.whats.team/docs/md/deleteMessage.md) — `DELETE /messages/{messageId}` ### Keypass - [Revoke the keypass helper token](https://app.whats.team/docs/md/disconnectKeypass.md) — `POST /keypass/disconnect` - [List keypass-connectable numbers](https://app.whats.team/docs/md/listKeypassDevices.md) — `GET /keypass/devices` - [Import keypass session credentials](https://app.whats.team/docs/md/importDeviceKeypass.md) — `POST /devices/{deviceId}/keypass` ### Integrations - [Vault](https://app.whats.team/docs/md/getInstallVault.md) — `GET /install/vault` - [Write vault](https://app.whats.team/docs/md/putInstallVault.md) — `PUT /install/vault` - [Install agents](https://app.whats.team/docs/md/listInstallAgents.md) — `GET /install/agents` - [Install](https://app.whats.team/docs/md/getInstall.md) — `GET /install` - [Update install](https://app.whats.team/docs/md/patchInstall.md) — `PATCH /install` - [Revoke install](https://app.whats.team/docs/md/revokeInstall.md) — `DELETE /install` - [Create pending connection](https://app.whats.team/docs/md/createPending.md) — `POST /bridges/pending` - [Bridge installs](https://app.whats.team/docs/md/listInstalls.md) — `GET /bridges/installs` - [Exchange install code](https://app.whats.team/docs/md/exchangeCode.md) — `POST /bridges/exchange` - [Read install key](https://app.whats.team/docs/md/getInstallKey.md) — `GET /install/kv/{key}` - [Write install key](https://app.whats.team/docs/md/setInstallKey.md) — `PUT /install/kv/{key}` - [Read bridge key](https://app.whats.team/docs/md/getBridgeKey.md) — `GET /bridges/kv/{key}` - [Write bridge key](https://app.whats.team/docs/md/setBridgeKey.md) — `PUT /bridges/kv/{key}` ### Files - [Search files](https://app.whats.team/docs/md/searchFiles.md) — `GET /files` - [Upload file](https://app.whats.team/docs/md/uploadFile.md) — `POST /files` - [Delete many files](https://app.whats.team/docs/md/deleteFiles.md) — `DELETE /files` - [Preview image](https://app.whats.team/docs/md/previewFile.md) — `GET /files/{fileId}/preview` - [Download file content](https://app.whats.team/docs/md/downloadFile.md) — `GET /files/{fileId}/download` - [Get file information](https://app.whats.team/docs/md/getFile.md) — `GET /files/{fileId}` - [Update file](https://app.whats.team/docs/md/updateFile.md) — `PATCH /files/{fileId}` - [Delete file](https://app.whats.team/docs/md/deleteFile.md) — `DELETE /files/{fileId}` ### Devices - [Get numbers](https://app.whats.team/docs/md/getDevices.md) — `GET /devices` - [Create number](https://app.whats.team/docs/md/createDevice.md) — `POST /devices` - [Delete chats](https://app.whats.team/docs/md/deleteChats.md) — `DELETE /devices/{deviceId}/chats` - [Get number by ID](https://app.whats.team/docs/md/getDeviceById.md) — `GET /devices/{deviceId}` - [Update number](https://app.whats.team/docs/md/updateDevice.md) — `PATCH /devices/{deviceId}` - [Delete number](https://app.whats.team/docs/md/deleteDevice.md) — `DELETE /devices/{deviceId}` ### Deals - [List account tasks](https://app.whats.team/docs/md/listDealTasks.md) — `GET /deals/tasks` - [Hydrate deals](https://app.whats.team/docs/md/hydrateDeals.md) — `POST /deals/hydrate` - [Get deals](https://app.whats.team/docs/md/getDeals.md) — `GET /deals` - [Create deal](https://app.whats.team/docs/md/createDeal.md) — `POST /deals` - [Dismiss the AI suggestion](https://app.whats.team/docs/md/dismissDealSuggestion.md) — `DELETE /deals/{dealId}/suggestion` - [Move deal to another stage](https://app.whats.team/docs/md/moveDealStage.md) — `PATCH /deals/{dealId}/stage` - [Dismiss the AI risk alert](https://app.whats.team/docs/md/dismissDealRisk.md) — `DELETE /deals/{dealId}/risk` - [Update deal note](https://app.whats.team/docs/md/updateDealNote.md) — `PATCH /deals/{dealId}/notes/{noteId}` - [Delete deal note](https://app.whats.team/docs/md/deleteDealNote.md) — `DELETE /deals/{dealId}/notes/{noteId}` - [List deal notes](https://app.whats.team/docs/md/listDealNotes.md) — `GET /deals/{dealId}/notes` - [Create deal note](https://app.whats.team/docs/md/createDealNote.md) — `POST /deals/{dealId}/notes` - [List deal history](https://app.whats.team/docs/md/listDealEvents.md) — `GET /deals/{dealId}/events` - [Link deal to a conversation](https://app.whats.team/docs/md/linkDealChat.md) — `PUT /deals/{dealId}/chat` - [Get deal](https://app.whats.team/docs/md/getDeal.md) — `GET /deals/{dealId}` - [Update deal](https://app.whats.team/docs/md/updateDeal.md) — `PATCH /deals/{dealId}` - [Archive deal](https://app.whats.team/docs/md/archiveDeal.md) — `DELETE /deals/{dealId}` ### Campaigns - [Get campaigns](https://app.whats.team/docs/md/getCampaigns.md) — `GET /campaigns` - [Create campaign](https://app.whats.team/docs/md/createCampaign.md) — `POST /campaigns` - [Start/stop campaign](https://app.whats.team/docs/md/updateCampaign.md) — `PUT /campaigns/{campaignId}/status` - [List campaign contacts](https://app.whats.team/docs/md/getCampaignContacts.md) — `GET /campaigns/{campaignId}/contacts` - [Update campaign contacts](https://app.whats.team/docs/md/updateCampaignContacts.md) — `PATCH /campaigns/{campaignId}/contacts` - [Delete campaign contacts](https://app.whats.team/docs/md/deleteCampaignContacts.md) — `DELETE /campaigns/{campaignId}/contacts` - [Get campaign](https://app.whats.team/docs/md/getCampaign.md) — `GET /campaigns/{campaignId}` - [Update campaign](https://app.whats.team/docs/md/updateCampaign.md) — `PATCH /campaigns/{campaignId}` - [Delete campaign](https://app.whats.team/docs/md/deleteCampaign.md) — `DELETE /campaigns/{campaignId}` ### Analytics - [Get analytics](https://app.whats.team/docs/md/getAnalytics.md) — `GET /analytics` ### Funnel - [Get pipeline summary](https://app.whats.team/docs/md/getPipelineSummary.md) — `GET /pipelines/{pipelineId}/summary` ### Chat Messages - [Get message delivery info](https://app.whats.team/docs/md/getMessageAckInfo.md) — `GET /chat/{deviceId}/messages/{messageWid}/ackinfo` - [Get message details](https://app.whats.team/docs/md/getDeviceMessageDetails.md) — `GET /chat/{deviceId}/messages/{messageWid}` - [Edit message](https://app.whats.team/docs/md/editMessage.md) — `PATCH /chat/{deviceId}/messages/{messageWid}` - [Delete message](https://app.whats.team/docs/md/deleteDeviceMessage.md) — `DELETE /chat/{deviceId}/messages/{messageWid}` - [Search messages](https://app.whats.team/docs/md/getChatMessages.md) — `GET /chat/{deviceId}/messages` ### Chat Files - [Download file](https://app.whats.team/docs/md/downloadDeviceFileDetails.md) — `GET /chat/{deviceId}/files/{fileId}/download` - [Get file details](https://app.whats.team/docs/md/getDeviceFileDetails.md) — `GET /chat/{deviceId}/files/{fileId}` - [Files](https://app.whats.team/docs/md/getDeviceFiles.md) — `GET /chat/{deviceId}/files` ### Chat Contacts - [Set metadata](https://app.whats.team/docs/md/updateContactMetadata.md) — `PUT /chat/{deviceId}/contacts/{contactWid}/metadata` - [Update metadata](https://app.whats.team/docs/md/upsertContactMetadata.md) — `PATCH /chat/{deviceId}/contacts/{contactWid}/metadata` - [Get contact](https://app.whats.team/docs/md/getDeviceContactDetails.md) — `GET /chat/{deviceId}/contacts/{contactWid}` - [Update contact](https://app.whats.team/docs/md/updateContact.md) — `PATCH /chat/{deviceId}/contacts/{contactWid}` - [Delete contact](https://app.whats.team/docs/md/deleteContact.md) — `DELETE /chat/{deviceId}/contacts/{contactWid}` - [Contacts](https://app.whats.team/docs/md/getDeviceContacts.md) — `GET /chat/{deviceId}/contacts` - [Create contact](https://app.whats.team/docs/md/createContact.md) — `POST /chat/{deviceId}/contacts` - [Bulk create contacts](https://app.whats.team/docs/md/bulkCreateContacts.md) — `PATCH /chat/{deviceId}/contacts` ### Chats - [Mark chat as read/unread](https://app.whats.team/docs/md/updateChatReadStatus.md) — `PATCH /chat/{deviceId}/chats/{chatWid}/unread` - [Sync chat messages](https://app.whats.team/docs/md/syncDeviceChatMessages.md) — `GET /chat/{deviceId}/chats/{chatWid}/sync` - [Update chat status](https://app.whats.team/docs/md/setChatStatus.md) — `PATCH /chat/{deviceId}/chats/{chatWid}/status` - [Assign chat](https://app.whats.team/docs/md/assignChatAgent.md) — `PATCH /chat/{deviceId}/chats/{chatWid}/owner` - [Unassign chat](https://app.whats.team/docs/md/unassignChatAgent.md) — `DELETE /chat/{deviceId}/chats/{chatWid}/owner` - [Create note](https://app.whats.team/docs/md/createChatNote.md) — `POST /chat/{deviceId}/chats/{chatWid}/notes` - [Delete note](https://app.whats.team/docs/md/deleteChatNote.md) — `DELETE /chat/{deviceId}/chats/{chatWid}/notes` - [Update chat labels](https://app.whats.team/docs/md/updateChatLabels.md) — `PATCH /chat/{deviceId}/chats/{chatWid}/labels` - [Update chat attributes](https://app.whats.team/docs/md/updateChatMeta.md) — `PATCH /chat/{deviceId}/chats/{chatWid}/attributes` - [Get chat by WID](https://app.whats.team/docs/md/getDeviceChatDetails.md) — `GET /chat/{deviceId}/chats/{chatWid}` - [Delete chat](https://app.whats.team/docs/md/deleteDeviceChat.md) — `DELETE /chat/{deviceId}/chats/{chatWid}` - [Search chats](https://app.whats.team/docs/md/getDeviceChats.md) — `GET /chat/{deviceId}/chats` - [Bulk chats update](https://app.whats.team/docs/md/bulkChatsUpdate.md) — `PATCH /chat/{deviceId}/chats` ### Quick Replies - [List quick replies](https://app.whats.team/docs/md/getQuickReplies.md) — `GET /devices/{deviceId}/quickReplies` - [Create quick reply](https://app.whats.team/docs/md/createQuickReply.md) — `POST /devices/{deviceId}/quickReplies` - [Update quick reply](https://app.whats.team/docs/md/updateQuickReply.md) — `PATCH /devices/{deviceId}/quickReplies` - [Delete quick replies](https://app.whats.team/docs/md/deleteQuickReplies.md) — `DELETE /devices/{deviceId}/quickReplies` ### Queue - [Queue stats](https://app.whats.team/docs/md/getQueueStatus.md) — `GET /devices/{deviceId}/queue` - [Update queue status](https://app.whats.team/docs/md/setQueueStatus.md) — `POST /devices/{deviceId}/queue` - [Transfer queued messages](https://app.whats.team/docs/md/routeQueue.md) — `PATCH /devices/{deviceId}/queue` - [Empty queue](https://app.whats.team/docs/md/emptyQueue.md) — `DELETE /devices/{deviceId}/queue` ### Profile - [Profile image](https://app.whats.team/docs/md/deviceProfileImage.md) — `GET /devices/{deviceId}/profile/image` - [Update profile image](https://app.whats.team/docs/md/updateProfileImage.md) — `PUT /devices/{deviceId}/profile/image` - [Get profile](https://app.whats.team/docs/md/deviceProfile.md) — `GET /devices/{deviceId}/profile` - [Update profile](https://app.whats.team/docs/md/deviceProfileUpdate.md) — `PATCH /devices/{deviceId}/profile` ### Labels - [List labels](https://app.whats.team/docs/md/getLabels.md) — `GET /devices/{deviceId}/labels` - [Create label](https://app.whats.team/docs/md/createLabel.md) — `POST /devices/{deviceId}/labels` - [Update label](https://app.whats.team/docs/md/updateLabel.md) — `PATCH /devices/{deviceId}/labels` - [Delete label](https://app.whats.team/docs/md/deletelabel.md) — `DELETE /devices/{deviceId}/labels` ### Billing - [Invoice PDF](https://app.whats.team/docs/md/getDeviceInvoicePDF.md) — `GET /devices/{deviceId}/invoices/{invoiceId}/pdf` - [List invoices](https://app.whats.team/docs/md/getDeviceInvoices.md) — `GET /devices/{deviceId}/invoices` ### Session - [Session health](https://app.whats.team/docs/md/deviceHealth.md) — `GET /devices/{deviceId}/health` ### Departments - [Get departments](https://app.whats.team/docs/md/getDepartments.md) — `GET /devices/{deviceId}/departments` - [Create department](https://app.whats.team/docs/md/createDepartment.md) — `POST /devices/{deviceId}/departments` - [Update department](https://app.whats.team/docs/md/updateDepartment.md) — `PATCH /devices/{deviceId}/departments` - [Delete department](https://app.whats.team/docs/md/deleteDepartment.md) — `DELETE /devices/{deviceId}/departments` ### Contacts - [Block contacts](https://app.whats.team/docs/md/blockContacts.md) — `POST /devices/{deviceId}/block` - [Unblock contacts](https://app.whats.team/docs/md/unblockContacts.md) — `DELETE /devices/{deviceId}/block` ### Automatic Replies - [Get auto replies](https://app.whats.team/docs/md/getAutoReplies.md) — `GET /devices/{deviceId}/autoreplies` - [Update auto replies](https://app.whats.team/docs/md/updateAutoReplies.md) — `PATCH /devices/{deviceId}/autoreplies` ### Automatic Assignment - [Get chats auto-assignment](https://app.whats.team/docs/md/getChatAutoAssignment.md) — `GET /devices/{deviceId}/autoassign` - [Update chats auto-assignment](https://app.whats.team/docs/md/updateChatAutoAssignment.md) — `PATCH /devices/{deviceId}/autoassign`