whatsapp · 57 tools · 1 triggers
Connect it
run auth whatsapp
run auth whatsapp --scope team # shared with the organization
Use it
run whatsapp # common commands
run whatsapp --all # every command
import { whatsapp } from "@boxd/run";
Common tools
| Tool | What it does |
|---|---|
delete-media | Delete a WhatsApp media file previously uploaded via the Media API. |
deregister-phone | Deregister a WhatsApp Business phone number from the Cloud API. |
get-business-compliance-info | Retrieve comprehensive business compliance information for a WhatsApp Business phone number. |
get-business-encryption | Retrieve the WhatsApp Business public key and its signature verification status. |
get-client-business-accounts | Retrieve WhatsApp Business Accounts shared with or managed by a business portfolio. |
get-commerce-settings | Get commerce settings for a WhatsApp Business phone number. Retrieves cart and catalog visibility settings for a specific WhatsApp Business phone number. |
get-flow-assets | List assets associated with a WhatsApp Flow. Use this action when you need to retrieve the assets (such as flow.json) that are associated with a WhatsApp Flow. |
get-owned-business-accounts | Retrieve WhatsApp Business Accounts owned by a business portfolio. |
get-settings | Get Cloud API settings for a WhatsApp Business phone number. |
get-template-library | Browse the pre-built message template library for WhatsApp Business Account. |
register-phone | Register a WhatsApp Business phone number for use with WhatsApp Cloud API. |
remove-assigned-user | Remove a user’s access from the WhatsApp Business Account. Use this action when you need to revoke a user’s access to a WhatsApp Business Account. |
set-two-step-verification | Set or reset the two-step verification PIN for a WhatsApp Business phone number. |
subscribe-app | Subscribe your application to receive webhook notifications for a WhatsApp Business Account (WABA). |
update-business-profile | Update WhatsApp Business Profile information including business details, contact information, and profile settings. |
update-flow-json | Update the Flow JSON configuration for a WhatsApp Flow. Use this action when you need to update or upload a new flow.json file for an existing WhatsApp Flow. |
upsert-message-template | Create or update a message template for the WhatsApp Business Account. |
All 57 tools
All 57 tools
| Tool | What it does |
|---|---|
block-users | Block one or more WhatsApp users to prevent them from sending messages to your business phone number. |
configure-conversational-automation | Configure conversational automation settings for a WhatsApp Business phone number. |
create-flow | Create a new WhatsApp Flow for the WhatsApp Business Account. |
create-max-price-agreements | Create a max price agreement for WhatsApp marketing messages pricing. |
create-message-template | Create a new message template for the WhatsApp Business Account. |
create-qr-code | Create a new QR code with a prefilled message for a WhatsApp Business phone number. |
create-upload-session | Create a resumable upload session for large file uploads to WhatsApp. |
delete-media | Delete a WhatsApp media file previously uploaded via the Media API. |
delete-message-template | Delete a message template from the WhatsApp Business Account by name. |
delete-qr-code | Delete a specific QR code from a WhatsApp Business phone number. |
deregister-phone | Deregister a WhatsApp Business phone number from the Cloud API. |
get-activities | Retrieve activity history for a WhatsApp Business Account. This action returns a paginated list of activities such as phone number verifications… |
get-business-account-details | Retrieve comprehensive details about a WhatsApp Business Account (WABA). |
get-business-compliance-info | Retrieve comprehensive business compliance information for a WhatsApp Business phone number. |
get-business-encryption | Retrieve the WhatsApp Business public key and its signature verification status. |
get-business-profile | Get the business profile information for a WhatsApp Business phone number. |
get-client-business-accounts | Retrieve WhatsApp Business Accounts shared with or managed by a business portfolio. |
get-commerce-settings | Get commerce settings for a WhatsApp Business phone number. Retrieves cart and catalog visibility settings for a specific WhatsApp Business phone number. |
get-flow-assets | List assets associated with a WhatsApp Flow. Use this action when you need to retrieve the assets (such as flow.json) that are associated with a WhatsApp Flow. |
get-join-requests | Get all pending join requests for a WhatsApp group. Use this action when you need to retrieve pending requests from users who want to join a WhatsApp group. |
get-media-info | Get metadata and download URL for uploaded WhatsApp media. Returns media ID, download URL (valid for 5 minutes), MIME type, SHA256 hash, and file size. |
get-message-history | Retrieve message history for a WhatsApp Business phone number. |
get-message-templates | Get all message templates for the WhatsApp Business Account. |
get-owned-business-accounts | Retrieve WhatsApp Business Accounts owned by a business portfolio. |
get-phone-number | Retrieve detailed information about a specific WhatsApp Business phone number. |
get-phone-numbers | Retrieve all phone numbers registered to your WhatsApp Business Account. |
get-schedules | Retrieve campaign schedules associated with a WhatsApp Business Account. |
get-settings | Get Cloud API settings for a WhatsApp Business phone number. |
get-subscribed-apps | Get all applications currently subscribed to webhooks for a WhatsApp Business Account. |
get-template-library | Browse the pre-built message template library for WhatsApp Business Account. |
get-template-status | Get the status and details of a specific message template. This is useful for checking if a template has been approved, rejected, or is still pending review. |
list-flows | List all WhatsApp Flows associated with the WhatsApp Business Account. |
list-groups | List all WhatsApp groups associated with a business phone number. |
list-qr-codes | Get a list of all QR codes for a WhatsApp Business phone number. |
list-solutions | Retrieve a paginated list of Multi-Partner Solutions for a WhatsApp Business Account. |
publish-flow | Publish a WhatsApp Flow to make it available for use. Use this action when you have finished designing and testing a WhatsApp Flow and are ready to… |
register-phone | Register a WhatsApp Business phone number for use with WhatsApp Cloud API. |
remove-assigned-user | Remove a user’s access from the WhatsApp Business Account. Use this action when you need to revoke a user’s access to a WhatsApp Business Account. |
send-contacts | Send contacts WhatsApp number. Note: The message will be delivered to the recipient only if they have initiated a conversation first. |
send-interactive-buttons | Send an interactive button message with up to 3 reply buttons to a WhatsApp user. |
send-interactive-list | Send an interactive list message to a WhatsApp number. List messages display a menu of options organized into sections. |
send-location | Send a location message with coordinates, name, and address to a WhatsApp user. |
send-media | Send a media message to a WhatsApp number. Note: The media will be delivered to the recipient only if they have texted first. |
send-media-by-id | Send media using a media ID from previously uploaded media. This is more efficient than sending media by URL as the media is already on WhatsApp servers. |
send-message | Send a text message to a WhatsApp user. Important: The recipient phone number must be registered on WhatsApp and must have initiated a conversation… |
send-template-message | Send a template message to a WhatsApp number. |
set-two-step-verification | Set or reset the two-step verification PIN for a WhatsApp Business phone number. |
subscribe-app | Subscribe your application to receive webhook notifications for a WhatsApp Business Account (WABA). |
unsubscribe-app | Unsubscribe your application from webhook events for a WhatsApp Business Account (WABA). |
update-business-account | Update metadata for a WhatsApp Flow including its name, categories, and endpoint URI. |
update-business-profile | Update WhatsApp Business Profile information including business details, contact information, and profile settings. |
update-commerce-settings | Set or update commerce settings for a WhatsApp Business phone number. |
update-flow-json | Update the Flow JSON configuration for a WhatsApp Flow. Use this action when you need to update or upload a new flow.json file for an existing WhatsApp Flow. |
update-settings | Update Cloud API settings for a WhatsApp Business phone number. |
upload-media | Upload media files (images, videos, audio, documents, stickers) to WhatsApp servers. |
upsert-message-template | Create or update a message template for the WhatsApp Business Account. |
verify-code | Verify the OTP code for a pre-verified phone number. Use when you need to complete phone number verification by submitting the received OTP code. |
Triggers (1)
Subscribe with.on(...) in a script. A trigger with required configuration takes it as the second argument.
| Trigger | Needs | What fires it |
|---|---|---|
| Message Status Updated | phone_number_id | Triggers when a WhatsApp message status changes. |