WhatsApp

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.

Untrusted display-only summary

List all WhatsApp Flows associated with the WhatsApp Business Account. Returns flow details including name, status, categories, and any validation errors. Use when you need to retrieve all available flows to select one for messaging or to check the status of existing flows.

Untrusted display-only summary

List all WhatsApp groups associated with a business phone number. Use this action when you need to retrieve the list of groups that a business phone number is a member of. This is useful for managing group memberships, sending messages to groups, or auditing group participation. Results can be paginated using the 'aft…

Untrusted display-only summary

Get a list of all QR codes for a WhatsApp Business phone number. Use this action when you need to retrieve all message QR codes associated with a specific WhatsApp Business phone number. This is useful for managing existing QR codes, checking their status, or obtaining their image URLs for display. The action supports…

Untrusted display-only summary

Retrieve a paginated list of Multi-Partner Solutions for a WhatsApp Business Account. Use when you need to view all multi-partner solutions (such as SMB solutions) associated with a WABA, including their status and owner application information. This action is useful for managing solution partnerships and understandin…

Untrusted display-only summary

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 make it available for users. The flow must be in DRAFT status and pass all validation checks before it can be published. Note: Once published, the flow cannot be unpublish…

Untrusted display-only summary

Register a WhatsApp Business phone number for use with WhatsApp Cloud API. Use when you need to register a phone number that has been added to your WhatsApp Business Account. This action requires setting up a two-step verification PIN (6 digits) for the phone number. The phone number must be verified and properly conf…

Untrusted display-only summary

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. This action is irreversible — the user will immediately lose access and cannot be recovered without reassigning them to the account.

Untrusted display-only summary

Send contacts WhatsApp number. Note: The message will be delivered to the recipient only if they have initiated a conversation first.

Untrusted display-only summary

Send an interactive button message with up to 3 reply buttons to a WhatsApp user. Interactive button messages allow recipients to quickly respond by tapping predefined buttons. Perfect for yes/no questions, multiple choice selections, quick actions, or call-to-action scenarios. IMPORTANT REQUIREMENTS: - The recipient…

Untrusted display-only summary

Send an interactive list message to a WhatsApp number. List messages display a menu of options organized into sections. Users tap a button to view the list and select one option. Perfect for product catalogs, service menus, or guided workflows. Supports up to 10 sections with up to 10 items per section (100 total opti…

Untrusted display-only summary

Send a location message with coordinates, name, and address to a WhatsApp user. This action allows you to share location information through WhatsApp Business API. The location message includes latitude/longitude coordinates, a location name, and address. Important: The recipient must have an active WhatsApp account.…

Untrusted display-only summary

Send a media message to a WhatsApp number. Note: The media will be delivered to the recipient only if they have texted first.

Untrusted display-only summary

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. Use upload_media action first to get the media ID. Note: The media will be delivered to the recipient only if they have texted first.

Untrusted display-only summary

Send a text message to a WhatsApp user. Important: The recipient phone number must be registered on WhatsApp and must have initiated a conversation with your business within the last 24 hours, OR you must use a template message (see WHATSAPP_SEND_TEMPLATE_MESSAGE) for the first message outside the 24-hour window. For…

Untrusted display-only summary

Send a template message to a WhatsApp number.

Untrusted display-only summary

Set or reset the two-step verification PIN for a WhatsApp Business phone number. Use when you need to change the 6-digit PIN that protects a registered phone number — for example after onboarding a new number, rotating credentials, or before re-registering. The initial PIN is set via register_phone; this action update…

Untrusted display-only summary

Subscribe your application to receive webhook notifications for a WhatsApp Business Account (WABA). This action registers the application to receive webhook events from the specified WABA. Use this action when you need to start receiving webhook notifications for a specific WhatsApp Business Account, such as when sett…

Untrusted display-only summary

Unsubscribe your application from webhook events for a WhatsApp Business Account (WABA). This action removes the application subscription from the specified WABA's webhook configuration. This action is irreversible — once unsubscribed, the application will no longer receive webhook events for this WABA. Re-subscribing…

Untrusted display-only summary

Update metadata for a WhatsApp Flow including its name, categories, and endpoint URI. Use when you need to modify the configuration or settings of an existing WhatsApp Flow.

Untrusted display-only summary

Update WhatsApp Business Profile information including business details, contact information, and profile settings. Use when you need to modify the business profile settings such as the about text, business category, address, description, email, and website URLs associated with a WhatsApp Business phone number. Note:…

Untrusted display-only summary

Set or update commerce settings for a WhatsApp Business phone number. Use this action to enable or disable shopping cart functionality and product catalog visibility for a specific WhatsApp Business phone number. The settings control whether customers can browse products and make purchases directly within WhatsApp. No…

Untrusted display-only summary

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. The Flow JSON defines the structure, screens, and behavior of the flow. This endpoint validates the JSON schema and returns any validation errors if the format i…

Untrusted display-only summary

Update Cloud API settings for a WhatsApp Business phone number. Use this action to modify calling features, user identity verification settings, payload encryption configuration, and data storage preferences for a specific WhatsApp Business phone number. Note: Only one setting type can be updated per request (calling,…

Untrusted display-only summary

Upload media files (images, videos, audio, documents, stickers) to WhatsApp servers. The uploaded media gets a media ID that can be used in send_media or other messaging actions. Supported formats: - Images: JPEG, PNG (max 5MB) - Videos: MP4, 3GPP (max 16MB) - Audio: AAC, M4A, AMR, MP3, OGG (max 16MB) - Documents: PDF…

Untrusted display-only summary

Create or update a message template for the WhatsApp Business Account. Use this action when you need to create a new message template or update an existing one with the same name. If a template with the same name and language exists, it will be updated. Otherwise, a new template will be created. Templates must be appr…

Untrusted display-only summary

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. The phone number must first be added to your WhatsApp Business Account and a verification code must have been requested through the setup process. This action completes the…

Untrusted display-only summary