Official scripts
Explore our curated collection of scripts
WhatsApp — Unblock contact
Unblock a previously-blocked WhatsApp contact by exact chat name. Safe to repeat: does nothing if the contact isn't blocked.
WhatsApp — Start new chat
Open a chat with a contact by name, even if you have no existing conversation with them. Returns the opened chat's header name. Throws if the contact isn't found.
WhatsApp — Get own profile
Read the logged-in WhatsApp account's own profile: display name, About/status text, phone number and profile picture. If the browser isn't linked to WhatsApp, it says so straight away instead of waiting for a UI that will never load.
Get WhatsApp Status Updates
Reads the list of contacts' recent Status updates (name, timestamp, whether already viewed).
WhatsApp — Archive chat
Archive or unarchive a chat by exact name. Archived chats still appear in search. Safe to repeat: returns success if the chat is already in the desired state.
WhatsApp — Get contact info
Open a chat by exact name and read its Contact-info panel: phone number, About text, shared media/links/docs count, and number of groups in common. For a 1:1 contact (for groups, use get_group_members). If the browser isn't linked to WhatsApp, it says so straight away instead of waiting for a chat list that will never load.
WhatsApp — Get starred messages
Open Menu → Starred messages and list all starred messages: the chat they belong to, sender, text, time and date. Returns [] if none are starred.
WhatsApp — Promote group admin
Promote a WhatsApp group member to admin by exact names. Notifies the group. You must be an admin yourself. Fails immediately with a clear error if the member is already an admin.
WhatsApp — Block contact
Block a WhatsApp contact by exact chat name, without reporting them. Safe to repeat: does nothing if the contact is already blocked. The person isn't notified.
WhatsApp — Forward message
Forward a specific message (by messageId) from one chat to one or more other chats (by exact name). Opens the source chat, forwards via the recipient picker, and confirms completion.
WhatsApp — Remove group member
Remove a member from a WhatsApp group by exact names. Admin-only; removal notifies the whole group and cannot be undone from here, so confirm the exact group and member name with the user before running.
WhatsApp — Edit message
Edit one of your own recently-sent messages (by messageId) with new text. Edit is only allowed within ~15 min of sending; the script fails loudly if the Edit option isn't available. Verifies the new text is shown.
WhatsApp — Mark chat read/unread
Mark a chat (by exact name) as read or unread. Safe to repeat: if the chat is already in the desired state, it returns success.
WhatsApp — Star message
Star or unstar a specific message (by messageId) in a chat. Safe to repeat: it returns success if the message is already in the desired state. Starred messages are readable via get_starred_messages.
WhatsApp — Pin chat
Pin or unpin a chat (by exact name) to/from the top of the chat list. Safe to repeat: if the chat is already in the desired state, it returns success. WhatsApp allows at most 3 pinned chats.
WhatsApp — Rename group
Rename a WhatsApp group: open by exact current name → group-info drawer → edit subject → save. Verifies the new subject. Admin-only. Notifies the group.
WhatsApp — Search messages
Global keyword search across all WhatsApp chats. Returns matching messages with the chat name, date label, matched snippet and message id. WhatsApp Web caps how many message hits it surfaces; older ones are only on the phone.
WhatsApp — List a chat's media, documents or links
List what has been shared in one WhatsApp chat, from the chat's own media, links and documents gallery — pick which view you want with `tab`. Documents come back with the message id, filename, size, caption and time, so they can be fed straight to download_media. Images and videos are the exception: the gallery does not expose an identifiable handle for them, so those entries return only WhatsApp's own accessible label — use get_conversation when you need to act on a specific photo or video. Links come back with the URL, its preview title and the surrounding message. Reaches further back than the conversation view, whose scrollback is bounded.
WhatsApp — Set group description
Set/replace a WhatsApp group's description by exact group name. Notifies the group's members.
WhatsApp — Add group member
Add a contact to an existing WhatsApp group, both named exactly. Confirms afterwards that the contact really appears in the group, and reports clearly if they were already a member. You must be an admin of the group, and the group is notified when someone is added.
WhatsApp — Get group invite link
Get the shareable invite link (https://chat.whatsapp.com/...) of a WhatsApp group by exact name. Opens the group-info drawer → Invite to group via link → reads the displayed link. Admin-only (non-admins can't see the link). Returns the group name and the invite URL.
WhatsApp — Get inbox
List the WhatsApp chat list (inbox): for each chat its name, date/time label, read/unread status, unread message count and last-message snippet. Ordered top→down (most recent first). `count` caps how many chats to return.
WhatsApp — Dismiss group admin
Dismiss a WhatsApp group member as admin by exact names. Applies immediately with no confirmation step and notifies the group. You must be an admin yourself. Throws if the member isn't currently an admin.
WhatsApp — Mute chat
Mute or unmute notifications for a WhatsApp chat, found by its exact name. When muting, choose how long: 8 hours, 1 week, or always. A chat that is already in the state you asked for is left untouched and reported as a success.
WhatsApp — Send message or attachment
Send a WhatsApp message to a chat picked either by its exact name (as returned by get_inbox) or by phone number in international format, which needs no saved contact. The message is either text, an attached image, video or document with an optional caption, or a saved contact's card. Confirms the send by inspecting the conversation afterwards — a delivery tick for text, a cleared upload for an attachment, the contact's own bubble for a card — and throws if WhatsApp flagged it as failed or left it stuck, rather than trusting the bubble appearing. Returns the message id, the account that sent it, and whether identical text was already in the conversation beforehand. Attachment bytes must be supplied inline, since they cannot be fetched from a URL at run time.