WhatsApp

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 i…

Untrusted display-only summary

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…

Untrusted display-only summary

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 be…

Untrusted display-only summary

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 ac…

Untrusted display-only summary

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.

Untrusted display-only summary

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 prefille…

Untrusted display-only summary

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 ex…

Untrusted display-only summary

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 fo…

Untrusted display-only summary

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…

Untrusted display-only summary

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…

Untrusted display-only summary

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 registe…

Untrusted display-only summary

Retrieve activity history for a WhatsApp Business Account. This action returns a paginated list of activities such as phone number verifications, user additions, and other administrative actions performed on the WABA. Use this action when you need to audit administrative actions, track changes to your WhatsApp Busines…

Untrusted display-only summary

Retrieve comprehensive details about a WhatsApp Business Account (WABA). Returns configuration, status, and settings information including account review status, business verification status, timezone, and ownership details. Use this action when you need to audit your WhatsApp Business Account configuration, verify ac…

Untrusted display-only summary

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…

Untrusted display-only summary

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 includ…

Untrusted display-only summary

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

Untrusted display-only summary

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 agenci…

Untrusted display-only summary

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 capabilitie…

Untrusted display-only summary

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…

Untrusted display-only summary

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 pagin…

Untrusted display-only summary

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. The download URL can be used to retrieve the actual media file.

Untrusted display-only summary

Retrieve message history for a WhatsApp Business phone number. Returns a paginated list of messages with their delivery status information, including events like delivery status updates, timestamps, and webhook information. Use this action when you need to track message delivery status, audit message history, or retri…

Untrusted display-only summary

Get all message templates for the WhatsApp Business Account. Templates are required for sending messages outside the 24-hour window and for marketing/utility messages.

Untrusted display-only summary

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 th…

Untrusted display-only summary

Retrieve detailed information about a specific WhatsApp Business phone number. Returns phone number details including verification status, quality rating, display number, verified business name, throughput limits, and webhook configuration. Use this to check phone number status, settings, and capabilities. To get avai…

Untrusted display-only summary

Retrieve all phone numbers registered to your WhatsApp Business Account. Returns phone number IDs, display numbers, verification status, quality ratings, and messaging throughput limits. Use the phone number ID from the response to send WhatsApp messages via other API actions.

Untrusted display-only summary

Retrieve campaign schedules associated with a WhatsApp Business Account. Use this action when you need to list all scheduled campaigns for a WABA, including their status, timing, and recurrence patterns.

Untrusted display-only summary

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 th…

Untrusted display-only summary

Get all applications currently subscribed to webhooks for a WhatsApp Business Account. Use this action when you need to retrieve the list of third-party applications or integrations that are subscribed to receive webhook events for a specific WABA.

Untrusted display-only summary

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.

Untrusted display-only summary