WhatsApp MCP server for AI agents
Let Claude, ChatGPT or your own agent read and act on WhatsApp: 44 typed functions through one MCP server. No WhatsApp API key needed.
- Site
- whatsapp.com
- Functions
- 44
- Sign-in
- For account actions
- Works with
- MCP, HTTP, Node, Python
Connect
An MCP server for WhatsApp alone, with one tool per function. Paste it into Claude, ChatGPT, Cursor or any MCP client as a remote server.
https://api.bowmark.ai/mcp/site/whatsappOne MCP server for WhatsApp and every other site Bowmark covers. Your agent looks up what it needs and calls it.
https://api.bowmark.ai/mcpSet it up in your clientBoth need a Bowmark API key. The quickstart gets you one and a first result in a few minutes. Functions that need a login use the person's own account: how sign-in works.
Functions
Open a function to see its arguments, what it returns and how to call it.
checkNumberSays whether a phone number (international format, digits only) has a WhatsApp account, the way WhatsApp Web's own send?phone= url does before…Arguments
Name Type Required phonestringYes Returns
WhatsappNumberCheckinterface WhatsappNumberCheck { phone: string; hasWhatsapp: boolean; chatId: string | null; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/checkNumberCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.checkNumber("14155238886");import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.checkNumber("14155238886"))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/checkNumber \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"phone":"14155238886"}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.checkNumber("14155238886");createClickToChatLinkBuilds WhatsApp's documented click-to-chat link for a phone number in international format, optionally with a pre-filled message.Arguments
Name Type Required phonestringYes messagestringNo Returns
stringHTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/createClickToChatLinkCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.createClickToChatLink("14155238886");import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.createClickToChatLink("14155238886"))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/createClickToChatLink \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"phone":"14155238886"}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.createClickToChatLink("14155238886");downloadMediaDownloads the attachment on one message (image, video, voice note, sticker or document) as base64 with its type, MIME type and size; the chat by its…Arguments
Name Type Required chatNamestringYes messageIdstringYes Returns
WhatsappMediainterface WhatsappMedia { messageId: string; type: "image" | "video" | "voice" | "sticker" | "document"; mimeType: string; sizeBytes: number; fileName: string | null; dataBase64: string; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/downloadMediaCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.downloadMedia("<chatName>", "<messageId>");import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.downloadMedia("<chatName>", "<messageId>"))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/downloadMedia \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"chatName":"<chatName>","messageId":"<messageId>"}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.downloadMedia("<chatName>", "<messageId>");findContactFinds people and chats in the caller's WhatsApp by name, phone number or username, the way WhatsApp Web's search box does: each match's displayed…Arguments
Name Type Required querystringYes Returns
WhatsappContactMatch[]interface WhatsappContactMatch { name: string; about: string | null; phone: string | null; isGroup: boolean; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/findContactCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.findContact("Jordan");import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.findContact("Jordan"))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/findContact \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"query":"Jordan"}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.findContact("Jordan");getBlogPostReads one WhatsApp Blog post by slug or url: its title, publish date and body text.Arguments
Name Type Required slugOrUrlstringYes Returns
WhatsappBlogPostinterface WhatsappBlogPost { slug: string; title: string; publishedAt: string | null; text: string; url: string; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/getBlogPostCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.getBlogPost("its-time-to-reserve-your-whatsapp-username");import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.getBlogPost("its-time-to-reserve-your-whatsapp-username"))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/getBlogPost \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"slugOrUrl":"its-time-to-reserve-your-whatsapp-username"}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.getBlogPost("its-time-to-reserve-your-whatsapp-username");getChannelReads a public WhatsApp Channel from its www.whatsapp.com/channel/<id> link (or the bare id): the channel's name, description, follower count as the…Arguments
Name Type Required args{ id: string }Yes Returns
WhatsappChannelinterface WhatsappChannel { id: string; name: string; description: string; followerCount: string; followerCountNumber: number; url: string; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/getChannelCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.getChannel({ id: "0029VaAvwQJ90x34WZ6FDg36" });import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.getChannel({"id": "0029VaAvwQJ90x34WZ6FDg36"}))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/getChannel \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"args":{"id":"0029VaAvwQJ90x34WZ6FDg36"}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.getChannel({ id: "0029VaAvwQJ90x34WZ6FDg36" });getChannelUpdatesReads the updates a channel the caller follows shows in WhatsApp Web, opened by its exact displayed name (from listFollowedChannels): each update's…Arguments
Name Type Required channelNamestringYes Returns
WhatsappChannelUpdate[]interface WhatsappChannelUpdate { id: string | null; text: string | null; time: string | null; type: "text" | "image" | "video" | "poll" | "other"; reactions: string[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/getChannelUpdatesCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.getChannelUpdates("WhatsApp");import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.getChannelUpdates("WhatsApp"))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/getChannelUpdates \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"channelName":"WhatsApp"}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.getChannelUpdates("WhatsApp");getChatMessagesReads the messages WhatsApp Web's own conversation panel currently renders for one chat, opened by its exact displayed name (from listChats or…Arguments
Name Type Required chatNamestringYes Returns
WhatsappMessage[]interface WhatsappMessage { id: string | null; sender: string | null; timestamp: string | null; text: string | null; type: "text" | "image" | "voice" | "document" | "poll" | "other"; quoted: string | null; reactions: string[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/getChatMessagesCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.getChatMessages("Jordan");import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.getChatMessages("Jordan"))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/getChatMessages \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"chatName":"Jordan"}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.getChatMessages("Jordan");getCommunityReads a WhatsApp Community the caller belongs to, opened by its exact displayed name in the Communities tab: its description, its announcement group…Arguments
Name Type Required communityNamestringYes Returns
WhatsappCommunityinterface WhatsappCommunity { name: string; description: string | null; announcementGroup: string | null; groups: string[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/getCommunityCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.getCommunity("Family");import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.getCommunity("Family"))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/getCommunity \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"communityName":"Family"}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.getCommunity("Family");getGroupInfoReads a group the caller belongs to, opened by its exact displayed name (from listChats or findContact): name, description, picture url, the drawer's…Arguments
Name Type Required groupNamestringYes Returns
WhatsappGroupInfointerface WhatsappGroupParticipant { name: string; isAdmin: boolean; } interface WhatsappGroupInfo { name: string; description: string | null; pictureUrl: string | null; createdAt: string | null; participants: WhatsappGroupParticipant[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/getGroupInfoCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.getGroupInfo("Family");import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.getGroupInfo("Family"))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/getGroupInfo \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"groupName":"Family"}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.getGroupInfo("Family");getGroupInviteLinkReads the current chat.whatsapp.com invite link of a group the caller administers, opened by its exact displayed name (from listChats).Arguments
Name Type Required groupNamestringYes Returns
WhatsappGroupInviteLinkinterface WhatsappGroupInviteLink { name: string; code: string; url: string; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/getGroupInviteLinkCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.getGroupInviteLink("Family");import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.getGroupInviteLink("Family"))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/getGroupInviteLink \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"groupName":"Family"}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.getGroupInviteLink("Family");getHelpArticleReads one WhatsApp Help Center article by its numeric id or faq.whatsapp.com url: title, the platform it is written for, and the article text with…Arguments
Name Type Required idOrUrlstringYes Returns
WhatsappHelpArticleinterface WhatsappHelpArticle { id: string; title: string; platform: string; url: string; text: string; links: Array<{ text: string; url: string }>; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/getHelpArticleCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.getHelpArticle("378279804439436");import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.getHelpArticle("378279804439436"))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/getHelpArticle \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"idOrUrl":"378279804439436"}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.getHelpArticle("378279804439436");getMyProfileReads the signed-in caller's own WhatsApp profile: display name, about text, profile photo url and phone number.Arguments
None.
Returns
WhatsappMyProfileinterface WhatsappMyProfile { phone: string | null; name: string | null; about: string | null; photoUrl: string | null; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/getMyProfileCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.getMyProfile();import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.getMyProfile())curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/getMyProfile \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.getMyProfile();listBlogPostsLists WhatsApp Blog posts (blog.whatsapp.com) newest first.Arguments
None.
Returns
WhatsappBlogPostTeaser[]interface WhatsappBlogPostTeaser { slug: string; title: string; publishedAt: string | null; url: string; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/listBlogPostsCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.listBlogPosts();import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.listBlogPosts())curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/listBlogPosts \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.listBlogPosts();listCatalogProductsLists the products in a WhatsApp Business catalog (from a wa.me/c/<number> link or the number) as WhatsApp Web's catalog panel shows them: each…Arguments
Name Type Required numberOrUrlstringYes Returns
WhatsappCatalogProduct[]interface WhatsappCatalogProduct { name: string; price: string | null; description: string | null; imageUrl: string | null; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/listCatalogProductsCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.listCatalogProducts("14155238886");import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.listCatalogProducts("14155238886"))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/listCatalogProducts \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"numberOrUrl":"14155238886"}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.listCatalogProducts("14155238886");listChatsLists the signed-in caller's chats off WhatsApp Web's own sidebar, newest activity first: each chat's displayed name (the identifier until a real…Arguments
None.
Returns
WhatsappChatSummary[]interface WhatsappChatSummary { name: string; lastMessage: string | null; timestamp: string | null; unreadCount: number; isGroup: boolean; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/listChatsCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.listChats();import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.listChats())curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/listChats \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.listChats();listContactsLists the caller's contacts off WhatsApp Web's own new-chat panel: each contact's displayed name (the identifier listChats/findContact use too)…Arguments
None.
Returns
WhatsappContact[]interface WhatsappContact { name: string; phone: string | null; about: string | null; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/listContactsCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.listContacts();import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.listContacts())curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/listContacts \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.listContacts();listFollowedChannelsLists the Channels the caller follows as WhatsApp Web's Channels tab shows them: each channel's displayed name, its latest-update preview line, the…Arguments
None.
Returns
WhatsappFollowedChannel[]interface WhatsappFollowedChannel { name: string; latestUpdate: string | null; time: string | null; verified: boolean; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/listFollowedChannelsCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.listFollowedChannels();import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.listFollowedChannels())curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/listFollowedChannels \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.listFollowedChannels();listStatusUpdatesLists the contacts who have a Status up in the caller's WhatsApp Web Status tab: each poster's displayed name, the row's time label and whether the…Arguments
None.
Returns
WhatsappStatusUpdate[]interface WhatsappStatusUpdate { name: string; time: string | null; viewed: boolean; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/listStatusUpdatesCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.listStatusUpdates();import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.listStatusUpdates())curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/listStatusUpdates \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.listStatusUpdates();previewBusinessCatalogPreviews a WhatsApp Business catalog link (wa.me/c/<number>) logged out: the business's display name and number as the catalog page shows them, and…Arguments
Name Type Required numberOrUrlstringYes Returns
WhatsappBusinessCataloginterface WhatsappBusinessCatalog { name: string; number: string; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/previewBusinessCatalogCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.previewBusinessCatalog("14155238886");import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.previewBusinessCatalog("14155238886"))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/previewBusinessCatalog \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"numberOrUrl":"14155238886"}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.previewBusinessCatalog("14155238886");previewGroupInvitePreviews a WhatsApp group invite link (chat.whatsapp.com/<code>) without joining: the group's name and image as the invite page shows them.Arguments
Name Type Required codeOrUrlstringYes Returns
WhatsappGroupInviteinterface WhatsappGroupInvite { code: string; name: string; image: string | null; url: string; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/previewGroupInviteCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.previewGroupInvite("JHjzgjxgx9n3JqALXxPQ8Q");import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.previewGroupInvite("JHjzgjxgx9n3JqALXxPQ8Q"))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/previewGroupInvite \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"codeOrUrl":"JHjzgjxgx9n3JqALXxPQ8Q"}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.previewGroupInvite("JHjzgjxgx9n3JqALXxPQ8Q");searchChannelsSearches WhatsApp's Channels directory the way WhatsApp Web's 'Find channels' does, by name or category, and returns each channel's displayed name…Arguments
Name Type Required querystringYes Returns
WhatsappChannelMatch[]interface WhatsappChannelMatch { name: string; followers: string | null; verified: boolean; url: string | null; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/searchChannelsCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.searchChannels("news");import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.searchChannels("news"))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/searchChannels \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"query":"news"}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.searchChannels("news");searchHelpCenterSearches WhatsApp's Help Center (faq.whatsapp.com) the way its search box does and returns each article's id, title, summary and url.Arguments
Name Type Required querystringYes Returns
WhatsappHelpSearchResult[]interface WhatsappHelpSearchResult { id: string; title: string; summary: string; url: string; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/searchHelpCenterCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.searchHelpCenter("linked devices");import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.searchHelpCenter("linked devices"))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/searchHelpCenter \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"query":"linked devices"}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.searchHelpCenter("linked devices");searchMessagesSearches the caller's WhatsApp messages the way WhatsApp Web's search box does: each matching message's chat (by displayed name, the identifier…Arguments
Name Type Required querystringYes Returns
WhatsappMessageMatch[]interface WhatsappMessageMatch { chat: string; text: string; timestamp: string | null; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/searchMessagesCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.searchMessages("hello");import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.searchMessages("hello"))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/searchMessages \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"query":"hello"}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.searchMessages("hello");
addGroupParticipantsAdds people to a group the caller administers, by contact or number, and reports per person whether they were added or need an invite.Arguments
Name Type Required groupNamestringYes participantsstring[]Yes Returns
WhatsappGroupChangeinterface WhatsappGroupChange { group: string; /** What was done, e.g. "created", "renamed", "added Sam", "removed Sam". */ applied: string[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/addGroupParticipantsCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.addGroupParticipants("<groupName>", []);import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.addGroupParticipants("<groupName>", []))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/addGroupParticipants \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"groupName":"<groupName>","participants":[]}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.addGroupParticipants("<groupName>", []);blockContactBlocks (default) or unblocks a contact by exact displayed name.Arguments
Name Type Required contactNamestringYes action"block" | "unblock"No Returns
WhatsappBlockChangeinterface WhatsappBlockChange { contact: string; /** "blocked" or "unblocked". */ applied: string[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/blockContactCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.blockContact("<contactName>");import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.blockContact("<contactName>"))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/blockContact \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"contactName":"<contactName>"}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.blockContact("<contactName>");createGroupCreates a WhatsApp group as the caller with a name and the starting participants, and returns its chat id and invite link.Arguments
Name Type Required namestringYes participantsstring[]Yes Returns
WhatsappGroupChangeinterface WhatsappGroupChange { group: string; /** What was done, e.g. "created", "renamed", "added Sam", "removed Sam". */ applied: string[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/createGroupCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.createGroup("<name>", []);import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.createGroup("<name>", []))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/createGroup \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"name":"<name>","participants":[]}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.createGroup("<name>", []);deleteMessageDeletes a message the caller sent, for everyone when WhatsApp still offers that and for the caller alone otherwise.Arguments
Name Type Required chatNamestringYes messageIdstringYes Returns
WhatsappMessageChangeinterface WhatsappMessageChange { chat: string; messageId: string; action: "edited" | "deleted"; text: string | null; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/deleteMessageCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.deleteMessage("<chatName>", "<messageId>");import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.deleteMessage("<chatName>", "<messageId>"))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/deleteMessage \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"chatName":"<chatName>","messageId":"<messageId>"}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.deleteMessage("<chatName>", "<messageId>");editMessageEdits the text of a message the caller sent, inside the window WhatsApp allows edits.Arguments
Name Type Required chatNamestringYes messageIdstringYes textstringYes Returns
WhatsappMessageChangeinterface WhatsappMessageChange { chat: string; messageId: string; action: "edited" | "deleted"; text: string | null; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/editMessageCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.editMessage("<chatName>", "<messageId>", "<text>");import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.editMessage("<chatName>", "<messageId>", "<text>"))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/editMessage \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"chatName":"<chatName>","messageId":"<messageId>","text":"<text>"}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.editMessage("<chatName>", "<messageId>", "<text>");followChannelFollows a Channel as the caller.Arguments
Name Type Required channelNamestringYes Returns
WhatsappChannelChangeinterface WhatsappChannelChange { channel: string; /** "followed" or "unfollowed". */ applied: string[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/followChannelCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.followChannel("<channelName>");import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.followChannel("<channelName>"))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/followChannel \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"channelName":"<channelName>"}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.followChannel("<channelName>");forwardMessageForwards one of the caller's messages (by the id getChatMessages returns) from one chat to another chat opened by its exact displayed name.Arguments
Name Type Required fromChatstringYes messageIdstringYes toChatstringYes Returns
WhatsappForwardinterface WhatsappForward { fromChat: string; toChat: string; messageId: string; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/forwardMessageCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.forwardMessage("<fromChat>", "<messageId>", "<toChat>");import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.forwardMessage("<fromChat>", "<messageId>", "<toChat>"))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/forwardMessage \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"fromChat":"<fromChat>","messageId":"<messageId>","toChat":"<toChat>"}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.forwardMessage("<fromChat>", "<messageId>", "<toChat>");joinGroupByInviteJoins a group from its chat.whatsapp.com invite link as the caller, and returns the group's chat id.Arguments
Name Type Required invitestringYes Returns
WhatsappGroupChangeinterface WhatsappGroupChange { group: string; /** What was done, e.g. "created", "renamed", "added Sam", "removed Sam". */ applied: string[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/joinGroupByInviteCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.joinGroupByInvite("<invite>");import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.joinGroupByInvite("<invite>"))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/joinGroupByInvite \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"invite":"<invite>"}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.joinGroupByInvite("<invite>");leaveGroupLeaves a group as the caller.Arguments
Name Type Required groupNamestringYes Returns
WhatsappGroupChangeinterface WhatsappGroupChange { group: string; /** What was done, e.g. "created", "renamed", "added Sam", "removed Sam". */ applied: string[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/leaveGroupCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.leaveGroup("<groupName>");import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.leaveGroup("<groupName>"))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/leaveGroup \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"groupName":"<groupName>"}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.leaveGroup("<groupName>");postStatusPosts a text Status update as the caller; their contacts see it for 24 hours.Arguments
Name Type Required textstringYes Returns
WhatsappStatusPostinterface WhatsappStatusPost { applied: string[]; text: string; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/postStatusCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.postStatus("<text>");import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.postStatus("<text>"))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/postStatus \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"text":"<text>"}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.postStatus("<text>");reactToMessageReacts to a message as the caller with an emoji, or removes the caller's reaction when emoji is omitted.Arguments
Name Type Required chatNamestringYes messageIdstringYes emojistringNo Returns
WhatsappReactioninterface WhatsappReaction { chat: string; messageId: string; emoji: string | null; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/reactToMessageCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.reactToMessage("<chatName>", "<messageId>");import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.reactToMessage("<chatName>", "<messageId>"))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/reactToMessage \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"chatName":"<chatName>","messageId":"<messageId>"}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.reactToMessage("<chatName>", "<messageId>");removeGroupParticipantsRemoves people from a group the caller administers, or promotes/demotes an admin.Arguments
Name Type Required groupNamestringYes participantsstring[]Yes Returns
WhatsappGroupChangeinterface WhatsappGroupChange { group: string; /** What was done, e.g. "created", "renamed", "added Sam", "removed Sam". */ applied: string[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/removeGroupParticipantsCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.removeGroupParticipants("<groupName>", []);import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.removeGroupParticipants("<groupName>", []))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/removeGroupParticipants \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"groupName":"<groupName>","participants":[]}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.removeGroupParticipants("<groupName>", []);sendMediaSends a file as the caller to a chat opened by its exact displayed name: an image or video with an optional caption, or a document.Arguments
Name Type Required chatNamestringYes file{ name: string; mimeType: string; contentBase64: string }Yes captionstringNo Returns
WhatsappSentMediainterface WhatsappSentMedia { chat: string; fileName: string; caption: string | null; id: string | null; time: string | null; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/sendMediaCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.sendMedia("<chatName>", {});import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.sendMedia("<chatName>", {}))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/sendMedia \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"chatName":"<chatName>","file":{}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.sendMedia("<chatName>", {});sendMessageSends a text message as the caller to a chat opened by its exact displayed name (from listChats or findContact), and returns the sent row's id and…Arguments
Name Type Required chatNamestringYes textstringYes Returns
WhatsappSentMessageinterface WhatsappSentMessage { chat: string; text: string; id: string | null; time: string | null; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/sendMessageCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.sendMessage("<chatName>", "<text>");import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.sendMessage("<chatName>", "<text>"))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/sendMessage \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"chatName":"<chatName>","text":"<text>"}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.sendMessage("<chatName>", "<text>");sendPollCreates a poll in a chat as the caller: a question, its options and whether several answers are allowed.Arguments
Name Type Required chatNamestringYes questionstringYes optionsstring[]Yes allowMultiplebooleanNo Returns
WhatsappSentPollinterface WhatsappSentPoll { chat: string; question: string; options: string[]; allowMultiple: boolean; id: string | null; time: string | null; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/sendPollCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.sendPoll("<chatName>", "<question>", []);import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.sendPoll("<chatName>", "<question>", []))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/sendPoll \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"chatName":"<chatName>","question":"<question>","options":[]}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.sendPoll("<chatName>", "<question>", []);unfollowChannelUnfollows a Channel as the caller.Arguments
Name Type Required channelNamestringYes Returns
WhatsappChannelChangeinterface WhatsappChannelChange { channel: string; /** "followed" or "unfollowed". */ applied: string[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/unfollowChannelCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.unfollowChannel("<channelName>");import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.unfollowChannel("<channelName>"))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/unfollowChannel \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"channelName":"<channelName>"}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.unfollowChannel("<channelName>");updateChatChanges a chat's state the way WhatsApp Web's chat menu does: archive or unarchive, pin or unpin, mute (8 hours, 1 week or always) or unmute, mark…Arguments
Name Type Required chatNamestringYes update{ archived?: boolean; pinned?: boolean; muted?: "8h" | "1w" | "always" | false; read?: boolean }Yes Returns
WhatsappChatUpdateinterface WhatsappChatUpdate { chat: string; applied: string[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/updateChatCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.updateChat("<chatName>", {});import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.updateChat("<chatName>", {}))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/updateChat \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"chatName":"<chatName>","update":{}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.updateChat("<chatName>", {});updateGroupChanges a group the caller administers: its name, description, picture, and the send/edit-info settings.Arguments
Name Type Required groupNamestringYes update{ name?: string; description?: string }Yes Returns
WhatsappGroupChangeinterface WhatsappGroupChange { group: string; /** What was done, e.g. "created", "renamed", "added Sam", "removed Sam". */ applied: string[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/updateGroupCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.updateGroup("<groupName>", {});import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.updateGroup("<groupName>", {}))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/updateGroup \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"groupName":"<groupName>","update":{}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.updateGroup("<groupName>", {});updatePrivacySettingsSets one privacy setting: who sees last seen, profile photo, about or status, who may add the caller to groups, or read receipts on/off.Arguments
Name Type Required setting"lastSeen" | "profilePhoto" | "about" | "status" | "groups" | "readReceipts"Yes value"everyone" | "contacts" | "nobody" | "on" | "off"Yes Returns
WhatsappPrivacyChangeinterface WhatsappPrivacyChange { setting: string; value: string; applied: string[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/updatePrivacySettingsCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.updatePrivacySettings("lastSeen", "everyone");import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.updatePrivacySettings("lastSeen", "everyone"))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/updatePrivacySettings \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"setting":"lastSeen","value":"everyone"}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.updatePrivacySettings("lastSeen", "everyone");updateProfileChanges the caller's own display name and/or about text.Arguments
Name Type Required update{ name?: string; about?: string }Yes Returns
WhatsappProfileChangeinterface WhatsappProfileChange { /** What was done, e.g. "name set", "about set". */ applied: string[]; }HTTP endpoint
POST https://api.bowmark.ai/v1/sites/whatsapp/updateProfileCall it
import { bowmark } from "@bowmark/web"; const result = await bowmark.providers.whatsapp.updateProfile({});import asyncio from bowmark_web import bowmark result = asyncio.run(bowmark.providers.whatsapp.updateProfile({}))curl -X POST https://api.bowmark.ai/v1/sites/whatsapp/updateProfile \ -H "Authorization: Bearer $BOWMARK_API_KEY" \ -H "Content-Type: application/json" \ -d '{"update":{}}'// The body of a run: the MCP run tool, or POST /v1/run return await bowmark.providers.whatsapp.updateProfile({});
Use it from code
- Node
npm i @bowmark/web - Python
pip install bowmark-web - HTTP
POST /v1/sites/whatsapp/<function> - OpenAPI
/v1/sites/whatsapp/openapi.json