WhatsApp

Retrieve the WhatsApp Business public key and its signature verification status. Use this action when you need to obtain the end-to-end encryption public key for a WhatsApp Business phone number. This is useful for setting up secure messaging integrations and verifying the authenticity of messages. The response includes the base64-encoded public key and its signature status.

Retrieve WhatsApp Business Accounts shared with or managed by a business portfolio. Use this action when you need to get WhatsApp Business Accounts (WABAs) that are client accounts shared with or managed by a specific business portfolio, as opposed to accounts directly owned by that business. This is useful for agencies managing accounts for multiple clients, or for businesses accessing accounts shared with them. The action supports filtering by business type, pagination with cursors, finding specific accounts by ID, and specifying which fields to return.

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. The response includes download URLs for each asset that can be used to fetch the actual content. Note: The download URLs are typically valid for a limited time period and should be used promptly after retrieval.

Browse the pre-built message template library for WhatsApp Business Account. This retrieves a list of available templates that can be used for messaging. Use when you need to discover available message templates for sending marketing, utility, or authentication messages to WhatsApp users.

Retrieve WhatsApp Business Accounts owned by a business portfolio. Use this action when you need to get all WhatsApp Business Accounts (WABAs) that are directly owned by a specific business. This differs from client accounts which are shared with the business. This is useful for managing your own accounts, querying their details, and navigating through paginated results. The action supports filtering by business type, pagination with cursors, finding specific accounts by ID, and specifying which fields to return.

Retrieve comprehensive business compliance information for a WhatsApp Business phone number. Returns regulatory and compliance details including entity registration status, grievance officer contact information, and customer care details. Use this action to verify business compliance status, review registered business information, and ensure proper contact details are configured for regulatory requirements. Use when you need to check business registration status, review grievance officer details for legal compliance, or verify customer care contact information for your WhatsApp Business account.

Get Cloud API settings for a WhatsApp Business phone number. Retrieves calling, storage, and payload encryption settings for a specific WhatsApp Business phone number. This includes information about call features, IP addresses for calling, data storage preferences, and encryption settings. Use this action to check the current configuration and capabilities of a phone number's Cloud API integration. Use when you need to verify the current Cloud API settings for a phone number, including calling features, encryption status, and data storage configuration.

Get commerce settings for a WhatsApp Business phone number. Retrieves cart and catalog visibility settings for a specific WhatsApp Business phone number. Use this action to check whether shopping cart and product catalog features are enabled for customer interactions. This is useful for managing e-commerce capabilities on your WhatsApp Business account. Use when you need to verify the current commerce configuration of a phone number before enabling shopping features or displaying products to customers.

Get the business profile information for a WhatsApp Business phone number. This includes business details like description, address, website, and contact info.

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. This is useful for group administration, moderation, and managing group membership. Results can be paginated using the 'after' and 'before' cursors from the paging response.

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 setting up a new integration or re-establishing webhook subscriptions after they were removed.

Create a new message template for the WhatsApp Business Account. Templates must be approved by WhatsApp before they can be used. Templates are required for marketing messages and messages sent outside the 24-hour window.

Create a new QR code with a prefilled message for a WhatsApp Business phone number. Use this action when you need to generate a shareable QR code that customers can scan to start a conversation with your business. When scanned, the QR code will automatically populate the message input field with the specified prefilled message, making it easy for customers to initiate contact. The QR code can be configured to generate an image (PNG or SVG format) which will be available in the response for download and sharing.

Create a resumable upload session for large file uploads to WhatsApp. This action initiates an upload session that allows you to upload large files in chunks. First create a session, then use the session ID and URI to upload file data in subsequent requests. This is useful for uploading videos and large images that exceed the size limits of direct uploads. Use this action when you need to upload media files larger than the direct upload limit, or when you want to implement resumable uploads for reliability.

Create a new WhatsApp Flow for the WhatsApp Business Account. Use this action when you want to create an interactive flow that can collect user data, guide users through a process, or provide structured interactions within WhatsApp conversations. The flow starts in DRAFT status and must be configured with Flow JSON before it can be published. Note: The created flow is in DRAFT status and must be published before it can be used. Use the UpdateFlowJson action to add the flow configuration.

Create a max price agreement for WhatsApp marketing messages pricing. Max price agreements set a ceiling on the per-conversation price you'll pay for WhatsApp messaging across your WhatsApp Business Account. This is useful for controlling costs and ensuring predictable pricing for your messaging campaigns. Use this action when you need to set up pricing agreements for marketing, utility, or authentication message types on your WhatsApp Business Account. Once created, the agreement will be applied to all applicable conversations.

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

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 must be a registered WhatsApp user - The recipient must have messaged your business first within the last 24 hours (WhatsApp's customer service window) - You can include 1-3 buttons per message - Each button can have a title (max 20 chars) and unique ID (max 256 chars) Use cases: Customer service menus, appointment confirmations, feedback collection, product selections.

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 options). Note: Recipients must have messaged you first within the last 24 hours to receive this message.

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. Additionally, you can only send free-form messages (like location messages) within the 24-hour customer service window after the recipient has initiated contact with your business. Outside this window, you must use approved message templates. Common error codes: - 133010: Recipient's phone number doesn't have a WhatsApp account - 131026: Message undeliverable (recipient may have blocked your business number) - 131047: Re-engagement message (outside 24-hour window, need to use template)

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 configured in WhatsApp Manager before registration. Note: Registration is required before you can send messages from this phone number. Once registered, the phone number will be associated with your WhatsApp Business Account.

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 updates the PIN on an already-registered phone number. Endpoint: `POST /{phone-number-id}` with body `{"pin": "XXXXXX"}`. Meta's two-step-verification reference page is SPA-rendered, so the operation is documented as a property update on the phone-number node itself rather than a dedicated sub-path.

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 is incorrect. Note: The uploaded Flow JSON will be validated against the Meta Flow JSON schema. If validation errors are returned, the update was not applied and you must fix the indicated issues before retrying.

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: Only fields that are provided will be updated. To clear an optional field, pass an empty string for text fields or an empty array for websites.

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 approved by WhatsApp before they can be used. Templates are required for marketing messages and messages sent outside the 24-hour window.

Configure conversational automation settings for a WhatsApp Business phone number. Sets up away messages, greeting messages, custom commands, and ice breaker prompts to automate customer interactions. Use this action to enable automated responses when your business cannot respond in real-time. Use this action when you need to: - Enable welcome messages for new customer conversations - Define custom bot commands for automated assistance - Set up conversation prompts (ice breakers) to guide customer interactions - Configure automated greeting messages for your WhatsApp Business number Note: The phone_number_id parameter refers to the Meta-assigned numeric ID, not the actual phone number. Obtain it using WHATSAPP_GET_PHONE_NUMBERS action.

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 unpublished. To make changes, you will need to create a new version of the flow.

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, user_identity_change, payload_encryption, or storage_configuration). The API uses a oneOf schema, so including multiple setting types will result in an error.

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. Note: At least one setting (is_cart_enabled or is_catalog_visible) should be provided in the request for meaningful updates.

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.

Delete a WhatsApp media file previously uploaded via the Media API. Use when you need to remove a media object you uploaded earlier (e.g. to free up storage or to retract content). The deletion is permanent — the media_id will no longer be retrievable. Note: media uploaded via Cloud API is normally retained by Meta for 30 days; this operation removes it before the automatic expiry.

Deregister a WhatsApp Business phone number from the Cloud API. Use when you need to stop sending messages from a phone number — for example before migrating it to another WhatsApp Business Account, before re-registering with a new PIN, or when retiring the number. After deregistration, the phone number can be registered again via register_phone. Destructive operation: after deregistration the phone number cannot send messages until it is registered again.

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.

Block one or more WhatsApp users to prevent them from sending messages to your business phone number. Use this action when you need to prevent specific users from contacting your business through WhatsApp. Blocked users will receive an error if they attempt to send messages to your business phone number. This action is irreversible — blocked users cannot unblock themselves and must contact your business directly to be unblocked. Note: You can block a maximum of 100 users per request.

Delete a message template from the WhatsApp Business Account by name. This permanently removes the template and it cannot be recovered. When you delete a template by name, all templates with that name across all languages will be deleted. Names of deleted templates cannot be reused for 30 days. Important: Only delete templates that are no longer needed, as this operation is irreversible.

Delete a specific QR code from a WhatsApp Business phone number. Use this action when you need to permanently remove a QR code that is no longer needed. This operation is irreversible — once deleted, the QR code cannot be recovered or recreated with the same identifier. This action permanently deletes the QR code and cannot be undone.

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 would need to be done through a separate action. Use this action when you need to stop receiving webhook notifications for a specific WhatsApp Business Account, such as when cleaning up old integrations or transitioning to a different app configuration.