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.

Functions
44
Sign-in
For account actions
Works with
MCP, HTTP, Node, Python

Connect

Just WhatsApp

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/whatsapp
Every site

One MCP server for WhatsApp and every other site Bowmark covers. Your agent looks up what it needs and calls it.

https://api.bowmark.ai/mcp
Set it up in your client

Both 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.

Read 24
  • 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

    NameTypeRequired
    phonestringYes

    Returns WhatsappNumberCheck

    interface WhatsappNumberCheck {
      phone: string;
      hasWhatsapp: boolean;
      chatId: string | null;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/whatsapp/checkNumber

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.whatsapp.checkNumber("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

    NameTypeRequired
    chatNamestringYes
    messageIdstringYes

    Returns WhatsappMedia

    interface 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/downloadMedia

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = 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

    NameTypeRequired
    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/findContact

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.whatsapp.findContact("Jordan");
  • getBlogPostReads one WhatsApp Blog post by slug or url: its title, publish date and body text.

    Arguments

    NameTypeRequired
    slugOrUrlstringYes

    Returns WhatsappBlogPost

    interface WhatsappBlogPost {
      slug: string;
      title: string;
      publishedAt: string | null;
      text: string;
      url: string;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/whatsapp/getBlogPost

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = 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

    NameTypeRequired
    args{ id: string }Yes

    Returns WhatsappChannel

    interface WhatsappChannel {
      id: string;
      name: string;
      description: string;
      followerCount: string;
      followerCountNumber: number;
      url: string;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/whatsapp/getChannel

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = 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

    NameTypeRequired
    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/getChannelUpdates

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = 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

    NameTypeRequired
    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/getChatMessages

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = 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

    NameTypeRequired
    communityNamestringYes

    Returns WhatsappCommunity

    interface WhatsappCommunity {
      name: string;
      description: string | null;
      announcementGroup: string | null;
      groups: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/whatsapp/getCommunity

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = 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

    NameTypeRequired
    groupNamestringYes

    Returns WhatsappGroupInfo

    interface 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/getGroupInfo

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.whatsapp.getGroupInfo("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

    NameTypeRequired
    idOrUrlstringYes

    Returns WhatsappHelpArticle

    interface 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/getHelpArticle

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = 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 WhatsappMyProfile

    interface WhatsappMyProfile {
      phone: string | null;
      name: string | null;
      about: string | null;
      photoUrl: string | null;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/whatsapp/getMyProfile

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = 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/listBlogPosts

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = 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

    NameTypeRequired
    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/listCatalogProducts

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = 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/listChats

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = 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/listContacts

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = 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/listFollowedChannels

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = 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/listStatusUpdates

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = 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

    NameTypeRequired
    numberOrUrlstringYes

    Returns WhatsappBusinessCatalog

    interface WhatsappBusinessCatalog {
      name: string;
      number: string;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/whatsapp/previewBusinessCatalog

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = 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

    NameTypeRequired
    codeOrUrlstringYes

    Returns WhatsappGroupInvite

    interface WhatsappGroupInvite {
      code: string;
      name: string;
      image: string | null;
      url: string;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/whatsapp/previewGroupInvite

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = 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

    NameTypeRequired
    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/searchChannels

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = 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

    NameTypeRequired
    querystringYes

    Returns WhatsappHelpSearchResult[]

    interface WhatsappHelpSearchResult {
      id: string;
      title: string;
      summary: string;
      url: string;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/whatsapp/searchHelpCenter

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = 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

    NameTypeRequired
    querystringYes

    Returns WhatsappMessageMatch[]

    interface WhatsappMessageMatch {
      chat: string;
      text: string;
      timestamp: string | null;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/whatsapp/searchMessages

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.whatsapp.searchMessages("hello");
Act 20
  • 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

    NameTypeRequired
    groupNamestringYes
    participantsstring[]Yes

    Returns WhatsappGroupChange

    interface 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/addGroupParticipants

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.whatsapp.addGroupParticipants("<groupName>", []);
  • blockContactBlocks (default) or unblocks a contact by exact displayed name.

    Arguments

    NameTypeRequired
    contactNamestringYes
    action"block" | "unblock"No

    Returns WhatsappBlockChange

    interface WhatsappBlockChange {
      contact: string;
      /** "blocked" or "unblocked". */
      applied: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/whatsapp/blockContact

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = 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

    NameTypeRequired
    namestringYes
    participantsstring[]Yes

    Returns WhatsappGroupChange

    interface 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/createGroup

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = 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

    NameTypeRequired
    chatNamestringYes
    messageIdstringYes

    Returns WhatsappMessageChange

    interface WhatsappMessageChange {
      chat: string;
      messageId: string;
      action: "edited" | "deleted";
      text: string | null;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/whatsapp/deleteMessage

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.whatsapp.deleteMessage("<chatName>", "<messageId>");
  • editMessageEdits the text of a message the caller sent, inside the window WhatsApp allows edits.

    Arguments

    NameTypeRequired
    chatNamestringYes
    messageIdstringYes
    textstringYes

    Returns WhatsappMessageChange

    interface WhatsappMessageChange {
      chat: string;
      messageId: string;
      action: "edited" | "deleted";
      text: string | null;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/whatsapp/editMessage

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.whatsapp.editMessage("<chatName>", "<messageId>", "<text>");
  • followChannelFollows a Channel as the caller.

    Arguments

    NameTypeRequired
    channelNamestringYes

    Returns WhatsappChannelChange

    interface WhatsappChannelChange {
      channel: string;
      /** "followed" or "unfollowed". */
      applied: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/whatsapp/followChannel

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = 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

    NameTypeRequired
    fromChatstringYes
    messageIdstringYes
    toChatstringYes

    Returns WhatsappForward

    interface WhatsappForward {
      fromChat: string;
      toChat: string;
      messageId: string;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/whatsapp/forwardMessage

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = 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

    NameTypeRequired
    invitestringYes

    Returns WhatsappGroupChange

    interface 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/joinGroupByInvite

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.whatsapp.joinGroupByInvite("<invite>");
  • leaveGroupLeaves a group as the caller.

    Arguments

    NameTypeRequired
    groupNamestringYes

    Returns WhatsappGroupChange

    interface 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/leaveGroup

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.whatsapp.leaveGroup("<groupName>");
  • postStatusPosts a text Status update as the caller; their contacts see it for 24 hours.

    Arguments

    NameTypeRequired
    textstringYes

    Returns WhatsappStatusPost

    interface WhatsappStatusPost {
      applied: string[];
      text: string;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/whatsapp/postStatus

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = 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

    NameTypeRequired
    chatNamestringYes
    messageIdstringYes
    emojistringNo

    Returns WhatsappReaction

    interface WhatsappReaction {
      chat: string;
      messageId: string;
      emoji: string | null;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/whatsapp/reactToMessage

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.whatsapp.reactToMessage("<chatName>", "<messageId>");
  • removeGroupParticipantsRemoves people from a group the caller administers, or promotes/demotes an admin.

    Arguments

    NameTypeRequired
    groupNamestringYes
    participantsstring[]Yes

    Returns WhatsappGroupChange

    interface 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/removeGroupParticipants

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = 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

    NameTypeRequired
    chatNamestringYes
    file{ name: string; mimeType: string; contentBase64: string }Yes
    captionstringNo

    Returns WhatsappSentMedia

    interface WhatsappSentMedia {
      chat: string;
      fileName: string;
      caption: string | null;
      id: string | null;
      time: string | null;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/whatsapp/sendMedia

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = 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

    NameTypeRequired
    chatNamestringYes
    textstringYes

    Returns WhatsappSentMessage

    interface WhatsappSentMessage {
      chat: string;
      text: string;
      id: string | null;
      time: string | null;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/whatsapp/sendMessage

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = 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

    NameTypeRequired
    chatNamestringYes
    questionstringYes
    optionsstring[]Yes
    allowMultiplebooleanNo

    Returns WhatsappSentPoll

    interface 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/sendPoll

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.whatsapp.sendPoll("<chatName>", "<question>", []);
  • unfollowChannelUnfollows a Channel as the caller.

    Arguments

    NameTypeRequired
    channelNamestringYes

    Returns WhatsappChannelChange

    interface WhatsappChannelChange {
      channel: string;
      /** "followed" or "unfollowed". */
      applied: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/whatsapp/unfollowChannel

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = 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

    NameTypeRequired
    chatNamestringYes
    update{ archived?: boolean; pinned?: boolean; muted?: "8h" | "1w" | "always" | false; read?: boolean }Yes

    Returns WhatsappChatUpdate

    interface WhatsappChatUpdate {
      chat: string;
      applied: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/whatsapp/updateChat

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.whatsapp.updateChat("<chatName>", {});
  • updateGroupChanges a group the caller administers: its name, description, picture, and the send/edit-info settings.

    Arguments

    NameTypeRequired
    groupNamestringYes
    update{ name?: string; description?: string }Yes

    Returns WhatsappGroupChange

    interface 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/updateGroup

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = 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

    NameTypeRequired
    setting"lastSeen" | "profilePhoto" | "about" | "status" | "groups" | "readReceipts"Yes
    value"everyone" | "contacts" | "nobody" | "on" | "off"Yes

    Returns WhatsappPrivacyChange

    interface WhatsappPrivacyChange {
      setting: string;
      value: string;
      applied: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/whatsapp/updatePrivacySettings

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.whatsapp.updatePrivacySettings("lastSeen", "everyone");
  • updateProfileChanges the caller's own display name and/or about text.

    Arguments

    NameTypeRequired
    update{ name?: string; about?: string }Yes

    Returns WhatsappProfileChange

    interface WhatsappProfileChange {
      /** What was done, e.g. "name set", "about set". */
      applied: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/whatsapp/updateProfile

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.whatsapp.updateProfile({});

Use it from code