Skip to main content
WhatsApp logo
  • Category: phone & sms
  • Auth: OAUTH2, API_KEY
  • Composio-managed OAuth available? Yes
  • Tools: 58
  • Triggers: 1
  • Slug: WHATSAPP
  • Version: 20261101_00

Frequently Asked Questions

WhatsApp has a 24-hour customer service window. Recipients only receive messages within 24 hours of their last message to you. To message outside this window, use a template message.
No. The WhatsApp toolkit is for WhatsApp Business API flows, so the connected account needs to be backed by a WhatsApp Business Account (WABA). Personal WhatsApp accounts are not supported for these API flows.If you need to send or receive WhatsApp messages through the toolkit, set up or connect the relevant WABA-backed business account in Meta first.
The WABA ID, or WhatsApp Business Account ID, is required because the WhatsApp Business API needs it to identify the business account. Users can find it in Meta Developers under the app’s WhatsApp API Setup section, or fetch it programmatically by calling GET /me/businesses and then GET /{business_id}/owned_whatsapp_business_accounts with an access token.
Sending a WhatsApp template message requires a template to already exist in WhatsApp/Meta. The send-template tool sends an existing template by name/language and parameters; it does not remove the need to create and approve the template first.
Ensure all required fields are provided when initiating the connection. See the WhatsApp authentication details.

Tools

Slug: WHATSAPP_ACCEPT_BUSINESS_SOLUTIONAccept an invitation for the authenticated partner app to join a Multi-Partner Solution. Requires an eligible Solution Partner, Tech Provider, or Tech Partner and an invited app; the solution must be INITIATED. Review the solution’s name and owner/partner permissions before acceptance: accepted solutions cannot then be declined. Acceptance changes partner status to ACCEPTED and may activate the solution once all required partners accept. If the app will access onboarded client data, Meta additionally requires App Review approval for both whatsapp_business_management and whatsapp_business_messaging.

Input Parameters

string
required
Multi-Partner Solution ID from the invitation, partner_solutions webhook’s solution_id, or Partner solutions panel in the Meta App Dashboard.
string
Optional logging/debugging session identifier to track the acceptance flow across API calls.
string
required
Meta app ID of the invited partner accepting the solution. Must match the app that received the invitation; find it in the Meta App Dashboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_ACCEPT_SOLUTION_DEACTIVATIONAccept a pending Multi-Partner Solution deactivation request. Completes the partner approval workflow: ACTIVE/PENDING_DEACTIVATION becomes DEACTIVATED/NONE. The solution can no longer onboard clients through Embedded Signup. Requires an eligible partner setup and authorization for the solution; the multi-partner guide specifies solution-owner access. Outstanding payments must be settled and active campaigns concluded or transferred. Meta notifies partners and cleans up solution resources and permissions. Returns solution state, optionally restricted by fields, or a success acknowledgment as shown in the multi-partner guide. This does not initiate deactivation.

Input Parameters

string
Comma-separated response fields: id, name, status, status_for_pending_request, owner_permissions. Omit for provider defaults: name,status,status_for_pending_request.
string
required
Multi-Partner Solution ID from WHATSAPP_LIST_BUSINESS_SOLUTIONS, the Meta App Dashboard’s Partner solutions panel, or a partner_solutions webhook’s solution_id. Requires an ACTIVE solution with PENDING_DEACTIVATION.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_ADD_BUSINESS_PHONE_NUMBERAdd a preverified phone number to a partner-owned pool clients can purchase from. This partner inventory endpoint creates a preverified phone number entity for a WhatsApp Business Account. It is not ordinary WABA phone registration or an SMS verification workflow. The number must not already be registered to another WhatsApp Business Account.

Input Parameters

string
Optional User-Agent header identifying the client software.
string
required
WhatsApp Business Account ID used as Business-ID by this partner endpoint. Find it in Meta Business Manager or via the business management APIs.
string
required
Preverified partner-owned phone number to add. Accepts E.164 or formatted numbers with spaces, hyphens, and parentheses (for example, +1 (631) 555-1000); the provider normalizes and validates it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_APPROVE_GROUP_JOIN_REQUESTSApprove pending WhatsApp group join requests by their join request IDs. Use for groups requiring join approval. Approved users can access the group when tapping its invite link. Requires a Groups API-eligible business number. HTTP 200 can include partial failures: inspect approved_join_requests, failed_join_requests, and errors to determine the outcome for each request.

Input Parameters

string
required
Group ID from the active groups listing or group creation webhook.
array
required
Join request IDs to approve. Obtain these from the group’s open join requests listing or group_participants_update webhooks; these are not WhatsApp user IDs.
string
Messaging product; must be whatsapp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_ASSIGN_USERAssign a Facebook user or system user to a WhatsApp Business Account with specified tasks. Grants account access for the supplied permission tasks. Authenticate using a System User access token with admin permissions and provide the intended Facebook user or system user ID. Returns the provider’s success flag.

Input Parameters

string
required
Facebook user or system user ID to add. Find Facebook user IDs in Meta business settings or business user management APIs; retrieve system user IDs from /{WHATSAPP_BUSINESS_ACCOUNT_ID}/system_users. Authenticate using a System User access token with admin permissions.
array
required
Permission tasks to grant to the user on the WhatsApp Business Account. MANAGE_BILLING is needed for sharing a Line of Credit. Request the needed granular tasks; MANAGE requires full solution access including MESSAGING for shared Multi-Partner Solutions.
string
required
WhatsApp Business Account ID. Find it in Meta Business Manager or account management APIs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_BLOCK_USERSBlock 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.

Input Parameters

array
required
List of users to block. Each user must be identified by their WhatsApp phone number in international format without the + sign (e.g., ‘16505551234’). Maximum of 100 users per request.
string
required
The Meta-assigned numeric ID for the WhatsApp Business phone number to block users from. This is NOT the actual phone number itself - it is a numeric ID (e.g., ‘712594308615206’) assigned by Meta. Obtain it using WHATSAPP_GET_PHONE_NUMBERS action which returns the ‘id’ field for each phone number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_CONFIGURE_CONVERSATIONAL_AUTOMATIONConfigure conversational automation for a WhatsApp Business phone number, including welcome-message enablement, custom commands, and ice breaker prompts. The welcome-message setting defaults to false when omitted.

Input Parameters

array
List of conversation prompts (ice breakers) up to 3 items. Each prompt must be 1-80 characters. These guide customers with suggested conversation starters.
array
List of bot commands (up to 30) for automated responses. Each command has a name and description. Use this to define custom commands users can trigger.
string
required
The Meta-assigned numeric ID for the WhatsApp Business phone number (e.g., ‘1234567890123456’). Get this from the WHATSAPP_GET_PHONE_NUMBERS action.
boolean
Whether to enable the welcome message for new conversations. When enabled, the first message from a customer will trigger an automated greeting.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_CREATE_BUSINESS_ACCOUNTCreate a WhatsApp Business Account under a business portfolio. Requires portfolio permissions and an app capable of WABA creation. The new account remains pending until verification completes. Returns the WABA and payment account IDs; does not register a phone number or send messages.

Input Parameters

string
required
Human-readable account name; must be unique within the business portfolio.
string
Billing currency code in ISO 4217 format.
string
required
Business portfolio ID. Find it in Meta Business Suite business settings or business management APIs.
integer
Meta timezone ID for the account.
string ("ENTERPRISE" | "SMB")
WhatsApp Business Account type: ENTERPRISE or SMB.
string
Primary funding source ID (credit card or extended credit), available from your business billing settings. The source must be valid and active.
string
Purchase order number for billing reference.
string
Business portfolio ID when creating on behalf of another business. Find it in that business’s Meta Business Suite settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_CREATE_BUSINESS_SOLUTIONCreate a Multi-Partner Solution between an owner app and a partner app. Requires an eligible Solution Partner, Tech Provider, or Tech Partner setup and an accessible partner app. Assign MESSAGING to exactly one app. Creation initiates the solution and invites the partner; the partner must accept before it can be used with Embedded Signup. Returns the solution ID, not an active solution.

Input Parameters

string
required
Agreed human-readable solution name shown in both partners’ dashboards (2–75 characters).
string
required
Solution owner Facebook app ID. Find it in your Meta App Dashboard; the app must have the required partner capabilities.
string
required
Partner Facebook app ID, obtained from your agreed solution partner’s Meta App Dashboard. The app must be accessible to the requesting entity.
array
required
Configurable permissions for the owner app: [‘MESSAGING’] or []. Exactly one of owner_permissions and partner_permissions must contain MESSAGING; default partner permissions are automatic.
array
required
Configurable permissions for the partner app: [‘MESSAGING’] or []. Use [] when the owner handles messaging; exactly one app must receive MESSAGING.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_CREATE_FLOWCreate a WhatsApp Flow for the WhatsApp Business Account bound to the connection. The flow starts in draft and must be configured with Flow JSON and published before use.

Input Parameters

string
required
The name of the flow. Maximum 80 characters. Must be unique within your WhatsApp Business Account.
string
Optional: WhatsApp Business Account ID to use. If not provided, uses the waba_id from your connection configuration.
string
required
JSON array of category names as a string (e.g., ’[“OTHER”]’). Each flow must have at least one category. Common categories include: AUTHENTICATION, CONFIRMATION, LEAD_GENERATION, OTHER, etc.
string
required
The HTTPS URL where your flow logic is hosted. This endpoint must be accessible by Meta’s servers. The URL must start with https:// and should respond to incoming flow data requests.
string
Optional: ID of an existing flow to clone. If provided, the new flow will be a copy of the specified flow with the new name and categories. Use this to quickly create variations of existing flows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_CREATE_GROUPSubmit creation of a WhatsApp group for a business phone number. Requires an eligible Official Business Account using Cloud API. A successful response acknowledges the creation request; the group_lifecycle_update webhook reports creation success or failure and supplies the invite link on success. Omitted join_approval_mode defaults to auto_approve at WhatsApp.

Input Parameters

string
required
Group subject, at most 128 characters. WhatsApp trims whitespace.
string
Optional group description, at most 2048 characters.
string
required
Business phone number ID. Obtain it from WHATSAPP_GET_PHONE_NUMBERS or WhatsApp Manager.
string
required
Messaging product; must be whatsapp.
string ("approval_required" | "auto_approve")
Whether joining via the invite link requires approval. If omitted, WhatsApp defaults to auto_approve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_CREATE_MAX_PRICE_AGREEMENTSCreate 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.

Input Parameters

string
required
The 3-letter ISO currency code for the max price (e.g., ‘USD’, ‘EUR’, ‘INR’).
string
required
The WhatsApp Business Account (WABA) ID. This is the numeric ID for your business account, typically starts with a number like ‘944953772041385’.
string
required
The full name of the person signing this price agreement.
string ("marketing" | "utility" | "authentication")
required
The type of message for this price agreement. Use ‘marketing’ for promotional messages, ‘utility’ for transactional updates, or ‘authentication’ for one-time passwords.
string
required
The email address of the person signing this price agreement. This person will receive confirmation of the agreement.
integer
required
The maximum price in micros (1 million micros = 1 unit of currency). For example, 50000 micros = 0.05 in the specified currency.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_CREATE_MESSAGE_TEMPLATECreate 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.

Input Parameters

string
required
Unique template name. Must be lowercase, alphanumeric with underscores only. Maximum 512 characters. Example: ‘order_confirmation_v1’.
string ("AUTHENTICATION" | "MARKETING" | "UTILITY")
required
Template category. AUTHENTICATION: for OTP/verification codes. MARKETING: for promotional content (requires opt-in). UTILITY: for transactional updates like order status, appointments.
string
required
Template language code in ISO 639-1 format with country code. Examples: ‘en_US’ (US English), ‘es_ES’ (Spanish), ‘pt_BR’ (Brazilian Portuguese).
array
List of template components. Required when creating a template from scratch: must include at least one BODY component, and can optionally include one HEADER and one BUTTONS component. Omit when cloning a Template Library template via library_template_name.
boolean
Optional. Set to true to allow Meta to automatically assign/reassign the template category. If omitted, the template may be rejected due to miscategorization.
string
Optional. The exact name of a Meta Template Library template to clone (e.g. ‘order_confirmation_2’). When set, the template is created from the pre-approved library template instead of from scratch; components should be omitted.
object
Optional. Used with library_template_name. Object supplying body-level inputs for the library template (e.g. {‘add_contact_number’: true, ‘add_learn_more_link’: true, ‘add_security_recommendation’: true, ‘add_track_package_link’: true, ‘code_expiration_minutes’: 10}).
array
Optional. Used with library_template_name. List of button input objects supplying values for the library template’s buttons (e.g. [{‘type’: ‘PHONE_NUMBER’, ‘phone_number’: ‘+15551234567’}] or [{‘type’: ‘URL’, ‘url’: ‘https://example.com’}]).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_CREATE_OBO_MOBILITY_INTENTCreate an On-Behalf-Of mobility intent for an eligible WhatsApp Business Account. Requires an authorized solution provider with access to the WABA and source/target solutions in an eligible state. Initiates a transfer, handover, or related approval or cancellation operation. May trigger partner notifications and approval workflows; successful creation does not mean account migration has completed. The legacy OBO account ownership model is deprecated and replaced by partner-initiated account creation; this v23 endpoint is documented, but eligibility must be confirmed with the provider for the account before use.

Input Parameters

object
required
Mobility intent JSON body, including the source solution and operation type.
string
required
WhatsApp Business Account ID; discover via owned or shared business account listings. Requires an eligible account accessible to the authorized solution provider.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_CREATE_PHONE_NUMBERCreate a phone number registration within a WhatsApp Business Account. Starts onboarding, phone verification (unless pre-verified), and business name review. The account must have an available phone number slot and the number must not already be registered with WhatsApp Business. Can also initiate an on-premises-to-Cloud API migration. Use the phone number GET endpoint to monitor registration status; creation does not imply approval.

Input Parameters

string
Country code for the phone number.
string
required
WhatsApp Business Account ID where the number will be added. Find it in WhatsApp Manager or the business management APIs.
string
required
Phone number in E.164 format without the + prefix.
string
required
Business name to be verified for this phone number.
string
Pre-verified phone number ID for Business Solution Provider (BSP) scenarios; obtain it from your pre-verification workflow.
boolean
Whether this is a migration from the on-premises API to Cloud API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_CREATE_QR_CODECreate 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.

Input Parameters

string
required
The WhatsApp Business Account phone number ID for which to create the QR code. This ID is provided when you add a phone number to your WhatsApp Business Account.
string
Optional. Image format for the generated QR code. When specified, the response will include a qr_image_url field with the QR code image. Supported values: ‘PNG’ or ‘SVG’.
string
required
The pre-filled message text that will appear when customers use the QR code. This is the message they will send to your business when they scan the code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_CREATE_SCHEDULECreate a campaign schedule for the connection’s WhatsApp Business Account. Supply a template (HSM), audience, WABA customer status ID, name, description, and delivery Unix timestamp. Returns the created schedule ID.

Input Parameters

string
WhatsApp Business Account ID from WhatsApp Manager. If supplied, must match the connection’s WABA ID; otherwise the configured ID is used.
object
required
Required JSON payload for creating a campaign schedule.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_CREATE_UPLOAD_SESSIONCreate 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.

Input Parameters

string
Optional file name for the upload session. If not provided, a default name will be used.
string ("image/jpeg" | "image/png" | "video/mp4")
required
The MIME type of the file being uploaded. Supported types: image/jpeg, image/png, video/mp4.
integer
required
The size of the file in bytes. Must be a positive integer representing the exact file size.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_DELETE_FLOWDelete a WhatsApp Flow that is in DRAFT status. Use the Flow ID returned by creating or listing Flows. Published Flows cannot be deleted; only DRAFT Flows are eligible for deletion.

Input Parameters

string
required
ID of the Flow to delete. Obtain it from creating or listing Flows. Only Flows in DRAFT status can be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_DELETE_GROUPDelete a WhatsApp group and remove all participants, including the business. Use the group ID returned by listing groups or a group creation webhook. Requires an eligible Official Business Account using Cloud API. Final deletion success or failure is reported through the group_lifecycle_update webhook.

Input Parameters

string
required
ID of the WhatsApp group to delete. Obtain it from WHATSAPP_LIST_GROUPS or the group creation lifecycle webhook.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_DELETE_MEDIADelete 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.

Input Parameters

string
required
The WhatsApp media ID to delete (obtained from a prior upload_media call or a webhook).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_DELETE_MESSAGE_TEMPLATEDelete a WhatsApp Business Account message template by name, permanently removing all language variants unless a template ID is supplied to target one variant. Deleted template names cannot be reused for 30 days.

Input Parameters

string
required
The name of the template to delete. This will delete all templates with this name across all languages.
string
Optional. The template’s ID. Include this together with ‘name’ to delete only the single language variant with this template ID, instead of deleting all language variants sharing the name.
string
WhatsApp Business Account ID to target. If not provided, the WhatsApp Business Account ID from the connection metadata is used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_DELETE_PREVERIFIED_NUMBERPermanently delete a pre-verified phone number from the pre-verified list. Use the pre-verified node ID supplied by your BSP. Deletion cannot be undone and deleted numbers cannot be recovered. Ensure the number is not in active use before deleting it.

Input Parameters

string
required
Pre-verified phone number ID supplied by your Business Solution Provider (BSP) during pre-verification. This is a node ID, not the phone number itself.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_DELETE_QR_CODEDelete 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.

Input Parameters

string
required
The unique 14-character identifier of the QR code to delete. This is the code value returned when the QR code was created.
string
required
The WhatsApp Business Account phone number ID that owns the QR code to be deleted. This ID is provided when you add a phone number to your WhatsApp Business Account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_DEPRECATE_FLOWIrreversibly retire a published WhatsApp Flow by marking it DEPRECATED. The Flow must already be published. Deprecation prevents the Flow from being sent or opened, allowing its endpoint to be retired. A deprecated Flow cannot be deleted or restored to a previous state. Use WHATSAPP_LIST_FLOWS to find its ID and WHATSAPP_GET_FLOW to check its status before retiring it.

Input Parameters

string
required
ID of the published Flow to retire. Obtain it from WHATSAPP_LIST_FLOWS or WHATSAPP_CREATE_FLOW, and check its status with WHATSAPP_GET_FLOW. Deprecation is irreversible.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_DEREGISTER_PHONEDeregister 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.

Input Parameters

string
required
The ID of the phone number to deregister (the same ID used with register_phone).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_DOWNLOAD_MEDIADownload a WhatsApp media asset using its short-lived media URL. First obtain the URL with WHATSAPP_GET_MEDIA_INFO or a media webhook. Returns a downloadable file. URLs expire after five minutes; retrieve a new URL if the provider returns 404. Redirects are not followed.

Input Parameters

string
required
Absolute HTTPS media URL on lookaside.fbsbx.com returned by WHATSAPP_GET_MEDIA_INFO or an incoming media webhook. URLs expire after 5 minutes; retrieve a fresh URL if expired.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_EDIT_MESSAGE_TEMPLATEEdit an existing WhatsApp message template by ID. Components, when supplied, replace ALL existing components. The management guide permits APPROVED, REJECTED, or PAUSED templates; approved templates cannot change category and are limited to 10 edits per 30 days and one per 24 hours. Rejected or paused templates have unlimited edits. Meta reviews changes to approved or paused templates and automatically re-approves them unless review fails. Eligibility and category-dependent limits are enforced by Meta against the existing template state.

Input Parameters

string ("AUTHENTICATION" | "FREE_SERVICE" | "MARKETING" | "UTILITY")
Updated category. The category of an APPROVED template cannot be edited; omit this field for approved templates.
array
Complete replacement list of template component objects, not a partial component patch. Include all components to retain (HEADER, BODY, FOOTER, BUTTONS, or specialized components). Supply example values when using variables, and media handles for media headers. Component-specific fields such as buttons, examples, and carousel cards are preserved.
string
required
Message template ID to edit. Discover IDs with WHATSAPP_GET_MESSAGE_TEMPLATES.
string ("BOOKING_STATUS" | "CALL_PERMISSIONS_REQUEST" | "FLIGHT_DELAY_AND_GATE_CHANGE_ALERT" | "FRAUD_ALERT" | "ORDER_DETAILS" | "ORDER_STATUS" | "RICH_ORDER_STATUS")
Template sub-category for utility templates.
string
Display format for the template.
string ("NAMED" | "POSITIONAL")
Parameter format for the template’s variables.
boolean
Allow Meta to reassign the template category.
integer
Message time-to-live in seconds. Authentication: 30–900; utility: 30–43200; marketing (Marketing Messages API): 43200–2592000. Authentication and utility also accept -1 for 30 days. Limits depend on the existing template category, which need not be supplied in an edit.
Opt out of CTA URL link tracking.
boolean
Restrict delivery to the primary device only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_ACCOUNT_NUMBERRetrieve a WhatsApp Account Number node’s status and configuration. Use an account-number ID from WHATSAPP_GET_PHONE_NUMBERS. Returns account status, verification, quality, messaging tier, and certificates as selected with fields. For phone-number throughput and webhook settings instead, use WHATSAPP_GET_PHONE_NUMBER.

Input Parameters

string
Comma-separated fields to retrieve. Omit for provider defaults: id, display_phone_number, status. Available: id, display_phone_number, verified_name, status, quality_rating, country_code, country_dial_code, code_verification_status, name_status, messaging_limit_tier, account_mode, certificate, is_official_business_account, host_platform, is_on_biz_app, is_preverified_number, last_onboarded_time, new_certificate, new_display_name, new_name_status, platform_type.
string
required
WhatsApp Account Number ID, obtained from WHATSAPP_GET_PHONE_NUMBERS on your WhatsApp Business Account. Identifies the account-number entity, not a literal phone number; this operation retrieves account status and configuration rather than the phone-number node’s throughput/webhook details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_ACTIVITIESRetrieve a paginated activity history for the WhatsApp Business Account bound to the connection, including administrative actions such as phone number verifications and user additions.

Input Parameters

string
Cursor for pagination. Use this to get the next page of results.
integer
Maximum number of activity records to return per page. Default is 25, maximum is 100.
string
Unix timestamp or ISO 8601 date string. Only return activities that occurred after this time.
string
Unix timestamp or ISO 8601 date string. Only return activities that occurred before this time.
string
Cursor for pagination. Use this to get the previous page of results.
string
Comma-separated list of fields to include in the response. Default includes all available fields.
string
Optional: WhatsApp Business Account ID to query. If not provided, uses the waba_id from your connection configuration.
string
Filter activities by type. Can be a single type or comma-separated list of types (e.g., PHONE_NUMBER_VERIFIED,USER_ADDED).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_ASSIGNED_BUSINESS_ACCOUNTSRetrieve one page of WhatsApp Business Accounts assigned to a specific Meta user. Returns account IDs and names. Use paging.cursors.after or before with the corresponding request parameter to navigate pages. The connected app must have permission to read the user’s assigned accounts.

Input Parameters

string
Next-page cursor from paging.cursors.after.
integer
Maximum accounts per page, from 1 to 100. Provider default is 25.
string
Previous-page cursor from paging.cursors.before.
string
Comma-separated response fields: id, name. Omit for provider defaults (id, name).
string
required
Meta user ID whose assigned WhatsApp Business Accounts to retrieve. Find the user ID in your solution’s or partnership’s user management settings or Graph API user lookup.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_ASSIGNED_USERSList users assigned to a WhatsApp Business Account in a business context. Returns user details and pagination. Pass an after or before cursor from the response to retrieve another page; this action fetches one page per call.

Input Parameters

string
Next-page cursor from paging.cursors.after.
integer
Users per page (1–100); provider default is 25.
string
Previous-page cursor from paging.cursors.before.
string
Comma-separated response fields: id, name, business, user_type. Provider defaults to id,name.
string
required
WhatsApp Business Account ID, found in WhatsApp Manager or account-listing APIs.
string
required
ID of the business owning or accessing the account; find it in Business Settings. Required business context.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_BUSINESS_ACCOUNT_DETAILSRetrieve configuration and status details for the WhatsApp Business Account bound to the connection, including account review status, business verification status, timezone, and ownership details.

Input Parameters

string
Comma-separated list of fields to include in the response. Default includes all available fields.
string
WhatsApp Business Account ID to retrieve details for. If not provided, uses the waba_id from your connection configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_BUSINESS_BOTRetrieve a WhatsApp Business Bot’s prompts, commands and welcome-message setting. Supply the bot ID from Business Manager or bot creation/management APIs. Optionally select the documented node fields with a comma-separated fields string.

Input Parameters

string
Comma-separated fields to retrieve: id, prompts, commands, enable_welcome_message. Omit for the provider defaults (prompts, commands, enable_welcome_message).
string
required
WhatsApp Business Bot ID, provided when the bot is created and available in Business Manager or through bot management APIs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_BUSINESS_COMPLIANCE_INFORetrieve 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.

Input Parameters

string
Comma-separated list of fields to retrieve. Available fields: messaging_product, entity_name, entity_type, entity_type_custom, is_registered, grievance_officer_details, customer_care_details, whatsapp_business_account_id. If not specified, returns all default fields.
string
required
The WhatsApp Business phone number ID (e.g., ‘1234567890123456’). Get this from the WHATSAPP_GET_PHONE_NUMBERS action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_BUSINESS_ENCRYPTIONRetrieve 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.

Input Parameters

string
Comma-separated list of fields to include in the response. Available fields: business_public_key, business_public_key_signature_status. Default includes both fields.
string
required
Your WhatsApp Business phone number ID. This ID represents the phone number entity and can be obtained from your WhatsApp Business Account phone numbers list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_BUSINESS_PORTFOLIORetrieve a Meta business portfolio’s ID, name and timezone identifier. Supply a business portfolio ID from Meta Business Suite business settings. Optional fields selects the returned information. This reads the portfolio itself, rather than its WhatsApp Business Accounts or phone numbers.

Input Parameters

string
Comma-separated fields to return, for example id,name,timezone_id. Omit to use the provider’s default field selection.
string
required
Business portfolio ID, found in Meta Business Suite business settings. Use the portfolio ID, not a WhatsApp Business Account or phone number ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_BUSINESS_PROFILEGet the business profile information for a WhatsApp Business phone number. This includes business details like description, address, website, and contact info.

Input Parameters

string
Comma-separated list of fields to retrieve. Default includes all available fields.
string
required
The phone number ID to get the business profile for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_BUSINESS_PROFILE_NODERetrieve a WhatsApp Business Profile node by its profile ID. Returns the profile object directly, including its ID and selected business information. This is GET /{profile-id}, distinct from WHATSAPP_GET_BUSINESS_PROFILE, which reads the /whatsapp_business_profile edge of a phone number and extracts an entry from its data array.

Input Parameters

string
Comma-separated fields to retrieve: id,description,email,about,address,vertical,websites,profile_picture_url,verified_name,messaging_product. Omit for the provider’s default fields.
string
required
WhatsApp Business Profile node ID, found in WhatsApp Business Manager or through business management APIs. Supply the profile ID, not a phone number ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_CALL_PERMISSIONSCheck permission to call one WhatsApp user from a business phone number. Identify the user by phone number or BSUID. Returns their permission state and available calling/permission-request actions with rate limits. Calling must be enabled on the business phone number. This does not request permission or call.

Input Parameters

string
User’s business-scoped user ID (BSUID) or parent BSUID, obtained from messaging webhooks. Can identify the user instead of user_wa_id.
string
WhatsApp user’s phone number in international format, obtained from your customer or messaging webhook. Required unless recipient is provided.
string
required
Business phone number ID. Discover it with WHATSAPP_GET_PHONE_NUMBERS; this is not the display phone number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_CLIENT_BUSINESS_ACCOUNTSRetrieve 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.

Input Parameters

string
Find a specific WhatsApp Business Account by ID.
string
Cursor for forward pagination. Use the cursor from the previous response to get the next page of results.
integer
Maximum number of WhatsApp Business Accounts to return per page. Default is 25, maximum is 100.
string
Cursor for backward pagination. Use the cursor from the previous response to get the previous page of results.
string
Comma-separated list of fields to include in the response. Available fields: id, name, account_review_status, purchase_order_number, audiences, ownership_type, subscribed_apps, business_verification_status, country, currency, timezone_id, on_behalf_of_business_info, schedules, is_enabled_for_insights, dcc_config, message_templates, phone_numbers.
string
required
The Business ID representing the business portfolio whose client WhatsApp Business Accounts you want to retrieve. This can be found in your Meta Business Suite URL or through business management APIs.
array
Filter results by WhatsApp Business Account type (STANDARD or PREMIUM).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_COMMERCE_SETTINGSGet 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.

Input Parameters

string
required
The WhatsApp Business phone number ID (e.g., ‘527759822865714’). Get this from the WHATSAPP_GET_PHONE_NUMBERS action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_CONNECTED_CLIENT_BUSINESSESRetrieve one page of client businesses connected to a Meta application. Obtain the application ID from your Meta App Dashboard. Returns business IDs and names, with pagination cursors when available. Pass paging.cursors.after as after to fetch the next page, or paging.cursors.before as before to go back. This is application-level client discovery, not the caller’s owned-WABA list; use WHATSAPP_GET_OWNED_BUSINESS_ACCOUNTS for that. The provider’s app access rules determine which client businesses the connected credential can read.

Input Parameters

string
Next-page cursor from paging.cursors.after in a prior response.
integer
Maximum businesses per page (1–100). The provider defaults to 25 when omitted.
string
Previous-page cursor from paging.cursors.before in a prior response.
string
Comma-separated fields to retrieve: id, name. When omitted, the provider returns id and name.
string
required
Meta Application ID, found in your Meta App Dashboard when you create an application. This is an application ID, not a WhatsApp Business Account ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_EXTENDED_CREDITSRetrieve one page of a Meta Business Portfolio’s extended credit lines. Use this to discover credit line IDs, legal entities and requested balances before a credit-sharing workflow. Supply a Business Portfolio ID. Use the returned before/after cursors to navigate pages and fields to select details. Solution Partners need a system user token whose user has an Admin or Financial Editor role on the portfolio.

Input Parameters

string
Next-page cursor from paging.cursors.after.
integer
Requested number of credit lines per page.
string
Previous-page cursor from paging.cursors.before.
string
Comma-separated response fields: id, credit_type, balance, credit_available, max_balance, online_max_balance, allocated_amount, partition_from, owner_business, owner_business_name, is_automated_experience, legal_entity_name, send_bill_to_biz_name, liable_biz_name, receiving_credit_allocation_config, is_access_revoked, is_shared_credit_line_enabled_for_mpa. Omit for provider defaults.
string
required
Meta Business Portfolio ID, not a WhatsApp Business Account ID. Find it in Meta Business Suite > Business Settings > Business Info, or with WHATSAPP_GET_BUSINESS_PORTFOLIO.
boolean
When true, order owning credentials before receiving credentials.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_FLOWGet one WhatsApp Flow’s metadata, validation errors, preview, or health. Supply a Flow ID from creation or the owning account’s Flow listing. Omit fields for the provider’s default metadata, or select fields and expressions to retrieve a preview link or check health for a specific business number. This read operation can also mutate preview links: if the caller requests preview.invalidate(true), it generates a new link and invalidates the previous one. Preview links are shareable without login.

Input Parameters

string
Graph API fields expression. Omit to return id, name, status, categories, and validation_errors. Available fields: id, name, categories, preview, status, validation_errors, json_version, data_api_version, endpoint_uri, whatsapp_business_account, application, health_status. Use preview.invalidate(false) to retrieve a preview link without invalidating the existing one; preview.invalidate(true) generates a new link and invalidates the old one. Use health_status.phone_number(PHONE_NUMBER_ID) to check health for a specific business phone number. Combine expressions with commas. Legacy data_channel_uri is deprecated since Graph API v19.0; use endpoint_uri instead.
string
required
Flow ID returned when creating a Flow, or obtained by listing Flows for the owning WhatsApp Business Account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_FLOW_ASSETSList 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.

Input Parameters

string
required
The unique identifier of the flow. This is the ID assigned by Meta when the flow is created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_GROUPRetrieve metadata about one WhatsApp group by its group ID. Use fields to select group settings, participants, and participant count. Omitting fields leaves the provider’s minimal default response unchanged.

Input Parameters

string
Comma-separated fields to return: id, messaging_product, join_approval_mode, subject, description, suspended, creation_timestamp, participants, total_participant_count. Omit to use the provider’s minimal default response.
string
required
Group ID obtained from group creation, a group lifecycle webhook, or the active groups listing for your business phone number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_JOIN_REQUESTSRetrieve pending join requests for a WhatsApp group to help manage group membership. Results support before and after cursor pagination, with a page size of 1–100 requests.

Input Parameters

string
Cursor that points to the end of a page of data to retrieve the next page of results. Use the ‘after’ cursor from the previous response’s paging.cursors.
integer
Maximum number of join requests to return per page (1-100).
string
Cursor that points to the beginning of a page of data to retrieve the previous page of results. Use the ‘before’ cursor from the previous response’s paging.cursors.
string
required
The unique ID of the WhatsApp group to retrieve join requests for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_MAX_PRICE_AGREEMENTSCheck the max price beta agreement status for a Meta business portfolio. Returns none, pending, or accepted and the signer details when present. Use this to check enrollment in the Marketing Messages API max price beta. The agreement is signed once per Meta Business Suite, including for Solution Partners managing eligible clients. This read does not send an agreement email.

Input Parameters

string
required
Meta Business Suite (business portfolio) ID. Find it in Meta Business Suite business settings; this is not a WhatsApp Business Account or phone number ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_MEDIA_INFOGet 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.

Input Parameters

string
required
The WhatsApp media ID to retrieve information for (obtained from media upload or webhook notifications).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_MESSAGE_HISTORYRetrieve 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 retrieve detailed information about specific messages. Use when you want to check if messages were delivered, track message status changes, or retrieve delivery receipts for WhatsApp Business messages.

Input Parameters

string
Cursor for pagination. Use this to get the next page of results. This value comes from the ‘paging.cursors.after’ field in previous responses.
integer
Maximum number of message history entries to return per page. Default is 25, maximum is 100.
string
Cursor for pagination. Use this to get the previous page of results. This value comes from the ‘paging.cursors.before’ field in previous responses.
string
Comma-separated list of fields to include in the response. If not specified, default fields will be returned (id, message_id). Available fields: id, message_id, events{delivery_status,webhook_update_state,timestamp,application,webhook_uri,error_description}
string
Filter results by a specific WhatsApp message ID (WAMID). When provided, only message history for this specific message will be returned.
string
required
The WhatsApp Business phone number ID. This is the ID associated with your registered phone number in WhatsApp Business Manager.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_MESSAGE_HISTORY_EVENTSRetrieve one page of delivery status events for a Message History ID. Obtain the entry ID from message history APIs, then inspect status transitions, occurrence timestamps, application details, or webhook updates. Use the returned before/after cursors to request additional pages.

Input Parameters

string
Next-page cursor from paging.cursors.after.
integer
Events per page; provider default is 25, maximum 100.
string
Previous-page cursor from paging.cursors.before.
string
Comma-separated Graph fields. Available: cursor, node{id,delivery_status,error_description,occurrence_timestamp,status_timestamp,application,webhook_update_state,webhook_uri}. Defaults to cursor,node{id,delivery_status,occurrence_timestamp} when omitted.
string ("ACCEPTED" | "DELIVERED" | "ERROR" | "READ" | "SENT")
Return only events with this delivery status.
string
required
Message History ID obtained from message history APIs (the entry’s id, not a phone number ID or message WAMID).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_MESSAGE_TEMPLATESGet all message templates for the WhatsApp Business Account. Templates are required for sending messages outside the 24-hour window and for marketing/utility messages.

Input Parameters

string
Cursor for pagination to get templates after this cursor.
integer
The maximum number of templates to retrieve. Default is 25.
string
Optional comma-separated list of template fields to include in the response (e.g. ‘name,status,category,language,components’). If omitted, the API returns its default set of fields.
string
Filter by template status: APPROVED, PENDING, REJECTED, DISABLED, PAUSED, LIMIT_EXCEEDED.
string
Optional: WhatsApp Business Account ID to query. If not provided, uses the waba_id from your connection configuration. Only provide this if you need to override the configured WABA ID.
string
Filter by template category: AUTHENTICATION, MARKETING, UTILITY.
string
Filter by language code (e.g., ‘en_US’, ‘es_ES’).
string
Filter templates by name or content substring.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_MIGRATION_INTENTRetrieve a WhatsApp Business Account migration intent’s status and linked accounts. Use the ID obtained when creating the migration intent to monitor its lifecycle, check migration progress, or inspect its source, destination, and solution.

Input Parameters

string
Comma-separated response fields: id, status, destination_waba, solution, waba. Omit to use provider defaults (solution, status, destination_waba).
string
required
Migration intent ID returned when creating the migration intent; discover it through migration management APIs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_OFFICIAL_BUSINESS_ACCOUNT_STATUSRetrieve Official Business Account (OBA) application status for a business phone number. Use this to monitor verification progress or read its status message. Obtain the phone number ID from WHATSAPP_GET_PHONE_NUMBERS. This only reads status; it does not submit an OBA application.

Input Parameters

string
Comma-separated response fields: oba_status, status_message. Omit to request the provider’s default fields (oba_status, status_message).
string
required
WhatsApp Business phone number ID. Obtain it using WHATSAPP_GET_PHONE_NUMBERS; this is not the display phone number or WABA ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_OWNED_BUSINESS_ACCOUNTSRetrieve 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.

Input Parameters

string
Find a specific WhatsApp Business Account by ID within the owned accounts. Use this to quickly locate a specific account.
integer
Number of results to return in backward pagination. Maximum value is 100. Use with ‘before’ cursor for backward pagination.
string
Cursor for forward pagination. Use the cursor from the previous response to get the next page of results.
integer
Number of results to return in forward pagination. Maximum value is 100. Use with ‘after’ cursor for forward pagination.
string
Cursor for backward pagination. Use the cursor from the previous response to get the previous page of results.
string
Comma-separated list of fields to include in the response. Available fields: id, name, account_review_status, purchase_order_number, audiences, ownership_type, subscribed_apps, business_verification_status, country, currency, timezone_id, on_behalf_of_business_info, schedules, is_enabled_for_insights, dcc_config, message_templates, phone_numbers.
string
required
The Business ID representing the business portfolio that owns the WhatsApp Business Accounts. This can be found in your Business Manager settings.
array
Filter accounts by business type. Can specify multiple types like ENTERPRISE or SMB to filter between enterprise and small-medium business accounts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_PHONE_NUMBERRetrieve 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 available phone number IDs, first call WHATSAPP_GET_PHONE_NUMBERS.

Input Parameters

string
Comma-separated list of fields to retrieve. Available fields: id, display_phone_number, verified_name, code_verification_status, quality_rating, platform_type, throughput, webhook_configuration, last_onboarded_time. Default retrieves all available fields.
string
required
The WhatsApp Business phone number ID (e.g., ‘901139066420489’). Get this from the WHATSAPP_GET_PHONE_NUMBERS action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_PHONE_NUMBERSRetrieve a page of phone numbers registered to the connection’s WhatsApp Business Account. Results can include phone number IDs, display numbers, verification status, quality ratings, throughput limits, and paging information.

Input Parameters

integer
Maximum number of phone numbers to return per page (1-100). Use lower values for faster responses or when you only need a few numbers.
string
Optional: WhatsApp Business Account ID to query. If not provided, uses the waba_id from your connection configuration. Only provide this if you need to override the configured WABA ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_PREVERIFIED_NUMBERRetrieve a pre-verified phone number’s verification status, owner, and expiry. Supply the pre-verified number ID from your Business Solution Provider or WHATSAPP_LIST_PREVERIFIED_NUMBERS. Optionally select response fields.

Input Parameters

string
Comma-separated response fields: id, code_verification_status, code_verification_time, owner_business, phone_number, verification_expiry_time. Omit to use provider defaults.
string
required
Pre-verified phone number ID provided by your Business Solution Provider during pre-verification, or discovered through WHATSAPP_LIST_PREVERIFIED_NUMBERS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_PREVERIFIED_NUMBER_PARTNERSList partner businesses with access to a pre-verified WhatsApp phone number. Returns one page of Business nodes, with id and name by default. Select additional Business fields with fields; use before or after to navigate pages.

Input Parameters

string
Next-page cursor from paging.cursors.after.
integer
Maximum partner businesses per page (1–100). The provider defaults to 25 when omitted.
string
Previous-page cursor from paging.cursors.before.
string
Comma-separated Business node fields to retrieve. The provider defaults to id,name when omitted.
string
required
Pre-verified phone number ID, provided when created or found in WhatsApp Business Account management. This is not the phone number itself.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_QR_CODERetrieve one message QR code by phone number ID and QR code identifier. Returns its code, pre-filled message and deep link in a data array. Request qr_image_url.format(SVG) or qr_image_url.format(PNG) in fields for an image URL. Use WHATSAPP_LIST_QR_CODES to discover existing QR code identifiers.

Input Parameters

string
Comma-separated fields to retrieve: code, prefilled_message, deep_link_url (always included), creation_time (first-party apps only), and qr_image_url.format(SVG) or qr_image_url.format(PNG). For example: code,prefilled_message,qr_image_url.format(SVG).
string
required
The QR code’s unique 14-character identifier. Use the code returned by WHATSAPP_CREATE_QR_CODE or WHATSAPP_LIST_QR_CODES.
string
required
WhatsApp Business phone number ID that owns the QR code. Obtain it from WHATSAPP_GET_PHONE_NUMBERS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_REACH_ESTIMATEEstimate WhatsApp marketing message reach and costs at different max prices. Reads historical estimates for a Messaging account onboarded to the Marketing Messages API in an eligible country. This beta planning tool returns delivery and cost ranges, not guarantees of future performance. Supply geographic targeting and a historical lookback; this does not send messages.

Input Parameters

string
required
WhatsApp Business Account (Messaging account) ID. Find it in WhatsApp Manager or list accounts with WHATSAPP_LIST_BUSINESS_ACCOUNTS; do not use a phone number ID.
string ("L1D" | "L7D" | "L14D" | "L28D")
required
Historical lookback for estimates: L1D (1 day), L7D (7 days), L14D (14 days), or L28D (28 days).
object
required
Required geographic targeting, shaped as {‘geo_locations’: {‘countries’: [‘IN’]}}. Serialized to JSON in the query.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_SCHEDULESRetrieve campaign schedules for the WhatsApp Business Account configured on the connection. Results are paginated and can include status, timing, and recurrence information.

Input Parameters

string ("created_time.asc" | "created_time.desc" | "updated_time.asc" | "updated_time.desc")
Sort options for schedule results.
string
Cursor for pagination - retrieve records after this cursor.
integer
Maximum number of schedules to return per page.
string
Cursor for pagination - retrieve records before this cursor.
string
Comma-separated list of fields to include in the response. Available fields: id, name, status, schedule_type, description, start_time, end_time, timezone, days_of_week, created_time, updated_time, is_active, recurrence_pattern. Defaults to ‘id,name,status,schedule_type’.
string
Optional: WhatsApp Business Account ID to query. If not provided, uses the waba_id from your connection configuration.
string
JSON-encoded array of filter conditions. Each filter should specify field, operator, and value. Supported fields: status, schedule_type, is_active. Example: [{“field”:“status”,“operator”:“EQUAL”,“value”:“ACTIVE”}]

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_SETTINGSGet 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.

Input Parameters

string
required
The WhatsApp Business phone number ID (e.g., ‘712594308615206’). Get this from the WHATSAPP_GET_PHONE_NUMBERS action.
boolean
Include SIP credentials in the response. Requires additional permissions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_SOLUTION_ACCESS_TOKENRetrieve an onboarded client’s business integration system user access token. Returns a SENSITIVE CREDENTIAL, not ordinary account information. Use only for an authorized solution partner/admin retrieving a token for a customer who shared a WABA with that Multi-Partner Solution through Embedded Signup. Supply the explicit solution ID and customer’s business portfolio ID from account_update; authenticate with the partner’s authorized system user token. Meta enforces partner and asset authorization. This does not retrieve the connection’s authentication token or grant access to arbitrary businesses. Store the returned client token securely and never log or disclose it.

Input Parameters

string
required
Explicit onboarded customer’s Business Portfolio ID from account_update.owner_business_id. The customer must have shared a WhatsApp Business Account with this solution.
string
required
Your authorized Multi-Partner Solution ID from the Partner Dashboard or account_update webhook; not a WABA ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_SUBSCRIBED_APPSGet 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.

Input Parameters

string
Comma-separated list of fields to include in the response. Available fields: id, name, link.
string
Optional: WhatsApp Business Account ID to query. If not provided, uses the waba_id from your connection configuration. Only provide this if you need to override the configured WABA ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_TEMPLATE_LIBRARYBrowse 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.

Input Parameters

string
Cursor for pagination to get templates after this cursor.
integer
The maximum number of templates to retrieve. Default is 25.
string
Filter by template status: APPROVED, PENDING, REJECTED, DISABLED, PAUSED, LIMIT_EXCEEDED.
string
Filter by country code (e.g., ‘US’, ‘GB’).
string
Filter by template category: AUTHENTICATION, MARKETING, UTILITY.
string
Filter by language code (e.g., ‘en_US’, ‘es_ES’).
string
Filter templates by name or content substring.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_TEMPLATE_STATUSGet 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.

Input Parameters

string
Comma-separated list of fields to retrieve. Valid fields include: id, name, status, category, language, components, previous_category, parameter_format, quality_score, rejected_reason. If not specified, returns all default fields.
string
required
The ID of the template to check the status for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_GET_UPLOAD_OFFSETGet the byte offset of an interrupted resumable upload. Use the session ID returned by WHATSAPP_CREATE_UPLOAD_SESSION, then pass the returned file_offset and remaining bytes to WHATSAPP_UPLOAD_FILE_CHUNK. The Resumable Upload API requires a user access token in the auth header.

Input Parameters

string
required
Session ID returned by WHATSAPP_CREATE_UPLOAD_SESSION. Pass the returned id, including upload: and any ?sig= signature, unchanged; a bare session ID is also accepted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_LIST_BLOCKED_USERSRetrieve one page of blocked users for a WhatsApp Business phone number. Returns data entries with messaging_product and wa_id, plus paging.cursors. Pass the returned after or before cursor to retrieve another page.

Input Parameters

string
Forward pagination cursor from paging.cursors.after.
integer
Maximum number of blocked users to return in this page.
string
Backward pagination cursor from paging.cursors.before.
string
required
WhatsApp Business phone number ID. Discover it with WHATSAPP_GET_PHONE_NUMBERS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_LIST_BUSINESS_ACCOUNTSList WhatsApp Business Accounts owned by a business portfolio. Uses Meta’s owned_whatsapp_business_accounts edge, the same owned-account resource as WHATSAPP_GET_OWNED_BUSINESS_ACCOUNTS. For accounts shared by other businesses, use WHATSAPP_GET_CLIENT_BUSINESS_ACCOUNTS instead. Use its business_type/find filters and limit/after/before pagination to return one page. Authenticate with a credential authorized to read this portfolio.

Input Parameters

string
Find a specific owned WABA by its ID from an account listing.
string
Next-page cursor from paging.cursors.after.
integer
Accounts per page (1–100); provider default: 25.
string
Previous-page cursor from paging.cursors.before.
string
Comma-separated response fields: id, name, account_review_status, purchase_order_number, currency, timezone_id, business_verification_status, country, on_behalf_of_business_info, is_enabled_for_insights, message_template_namespace. Provider defaults: id,name,currency,timezone_id.
string
required
Business portfolio ID, found in Meta Business Suite or through business management APIs.
array
Filter by WhatsApp Business Account types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_LIST_BUSINESS_SOLUTIONSList one page of Multi-Partner Solutions owned by or partnered with a Meta app. Use an Application ID from the App Dashboard and optionally filter by OWNER or PARTNER. Continue with returned paging cursors. This application-level listing differs from WHATSAPP_LIST_SOLUTIONS, which lists solutions that onboarded a WABA. Partner eligibility and access to the application are required by Meta.

Input Parameters

string ("OWNER" | "PARTNER")
Filter by the application’s relationship to the solution. Omit to include both owned and partnered solutions.
string
Next-page cursor from paging.cursors.after.
integer
Solutions per page (1–100); provider default: 25.
string
Previous-page cursor from paging.cursors.before.
string
Comma-separated fields: id, name, status, status_for_pending_request, owner_app, owner_permissions. Provider defaults: name,status,status_for_pending_request.
string
required
Meta Application ID from the App Dashboard. Use an application ID, not a WhatsApp Business Account (WABA) ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_LIST_FLOWSList 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.

Input Parameters

string
Cursor for pagination to get flows after this cursor.
integer
The maximum number of flows to retrieve per page (1-100). Default is 25. Use lower values for faster responses.
string
Optional: WhatsApp Business Account ID to query. If not provided, uses the waba_id from your connection configuration. Only provide this if you need to override the configured WABA ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_LIST_GROUPSList 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 ‘after’ and ‘before’ cursors from the paging response.

Input Parameters

string
Cursor that points to the end of a page of data to retrieve the next page of results. Use the ‘after’ cursor from the previous response’s paging.cursors.
integer
Maximum number of groups to return per page (1-100). Use lower values for faster responses or when you only need a few groups.
string
Cursor that points to the beginning of a page of data to retrieve the previous page of results. Use the ‘before’ cursor from the previous response’s paging.cursors.
string
required
The Meta-assigned numeric ID for the WhatsApp Business phone number. This is NOT the actual phone number itself - it is a numeric ID (e.g., ‘712594308615206’) assigned by Meta. Obtain it using WHATSAPP_GET_PHONE_NUMBERS action which returns the ‘id’ field for each phone number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_LIST_ON_BEHALF_REQUESTSList one page of in-progress on-behalf requests for a WhatsApp Business Account. Returns pending business relationship requests and optionally the receiving and requesting businesses. Continue using the returned before/after cursors. The legacy On-Behalf-Of (OBO) ownership model was replaced by partner-initiated account creation: client transfers were due October 1, 2025, with eligible accounts scheduled for batch migration through the end of 2025. This model retirement does not establish removal of this operation; the v23 reference does not mark the operation deprecated. Access requires an authorized partner principal and an accessible WABA with relevant OBO requests.

Input Parameters

string
Forward pagination cursor from paging.cursors.after.
integer
Results per page (1–100); provider default: 25.
string
Backward pagination cursor from paging.cursors.before.
string
Comma-separated fields: id, status, business_owned_object, receiving_business, requesting_business. Provider defaults: id,status,business_owned_object.
string
required
WhatsApp Business Account ID from WhatsApp Business Manager or the account listing APIs; not a phone number ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_LIST_PREVERIFIED_NUMBERSList pre-verified phone numbers available to a business portfolio. Optionally filter by phone number or verification status and select response fields. Returns one page; pass the returned before or after cursor to navigate pages.

Input Parameters

string
Next-page cursor from a previous response’s paging.cursors.after.
integer
Maximum number of phone numbers to return per page.
string
Previous-page cursor from a previous response’s paging.cursors.before.
string
Comma-separated response fields: id, code_verification_status, code_verification_time, owner_business, phone_number, verification_expiry_time.
string
required
Business portfolio ID. Find it in Meta Business Manager or through business management APIs.
string
Return only pre-verified numbers matching this phone number.
string ("EXPIRED" | "NOT_VERIFIED" | "VERIFIED")
Filter numbers by verification status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_LIST_QR_CODESGet 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 pagination through the ‘after’ and ‘before’ parameters, and can filter results by a specific QR code ID.

Input Parameters

string
Filter results to a specific QR code by its unique identifier.
string
Cursor for pagination. Use this to get the next page of results. Obtain this value from the paging.cursors.after field in previous responses.
integer
Maximum number of QR codes to return in a single response. Default is 25.
string
Cursor for pagination. Use this to get the previous page of results. Obtain this value from the paging.cursors.before field in previous responses.
string
Comma-separated list of fields to include in the response. Available fields: code, prefilled_message, deep_link_url, creation_time (first-party apps only), qr_image_url.format(SVG|PNG). Example: ‘code,prefilled_message,deep_link_url,qr_image_url.format(SVG)’
string
required
The WhatsApp Business Account phone number ID for which to list QR codes. This ID is provided when you add a phone number to your WhatsApp Business Account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_LIST_SOLUTIONSRetrieve a paginated list of Multi-Partner Solutions for the WhatsApp Business Account configured on the connection, including status and owner application information when returned.

Input Parameters

string
Cursor for pagination. Returns solutions after this cursor position. Use the cursor from the previous response’s paging.cursors.after field.
integer
Maximum number of solutions to return per page (1-100). Default is 25.
string
Cursor for pagination. Returns solutions before this cursor position. Use the cursor from the previous response’s paging.cursors.before field.
string
Comma-separated list of fields to include in the response. If not specified, default fields will be returned (id, name, status, status_for_pending_request). Available fields: id, name, status, status_for_pending_request, owner_app, owner_permissions.
string
Optional: WhatsApp Business Account ID to query. If not provided, uses the waba_id from your connection configuration. Only provide this if you need to override the configured WABA ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_MANAGE_CALLInitiate, pre-accept, accept, reject or terminate a WhatsApp WebRTC call. Calling must be enabled on the business number. Outbound connect requires the user’s calling permission. Supply an SDP offer for connect or an SDP answer for pre_accept/accept when sending a session. This sends signaling requests; the caller must operate a WebRTC media stack. Pre-accept establishes the media connection; start media only after accept returns 200 OK. Inbound calls must normally be accepted within 30–60 seconds of the Call Connect webhook.

Input Parameters

string
Callee phone number for connect; required unless recipient is supplied. Takes precedence over recipient.
string ("connect" | "pre_accept" | "accept" | "reject" | "terminate")
required
Call operation. connect starts an outbound call; other actions use call_id.
string
Required except for connect. Get from the inbound Call Connect webhook or outbound connect response.
object
Optional WebRTC SDP for connect (offer), pre_accept or accept (answer). On accept, match any previously supplied pre_accept answer.
string
Callee BSUID or parent BSUID for connect, obtained from user/contact webhooks; alternative or addition to to.
object
Optional recording configuration for connect or accept, independent of transcription.
object
Optional transcription configuration for connect or accept, independent of recording.
string
required
Business phone number ID; discover with WHATSAPP_GET_PHONE_NUMBERS.
string
Messaging account ID from onboarding/account discovery. Include when the token has messaging access to multiple accounts on this number; keep the same value for every request for a call.
string
Optional tracking string for connect or accept, echoed in call webhooks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_MIGRATE_FLOWSCopy up to 100 Flows between WABAs owned by the same Meta business. Copies keep their names and published/draft state, and receive new IDs. Source Flows remain unchanged. A name already present in the destination fails for that Flow while other Flows can succeed; inspect failed_flows even when the request succeeds. Omit source_flow_names to copy all source Flows, subject to the 100-Flow request limit.

Input Parameters

string
required
Source WhatsApp Business Account ID. Find it in Meta Business Settings > WhatsApp Accounts. Source Flows remain unchanged.
array
Names of source Flows to copy, as returned by WHATSAPP_LIST_FLOWS. Omit to copy all source Flows. Only 100 Flows can be migrated per request.
string
required
Destination WhatsApp Business Account ID. Find it in Meta Business Settings > WhatsApp Accounts. Must be owned by the same Meta business as the source account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_ONBOARD_MARKETING_PARTNERSSend a partner-initiated MM Lite onboarding request to an end business. Validates partner business and app permissions and end business eligibility, identifies eligible shared and on-behalf-of (OBO) WhatsApp Business Accounts, and creates a business agreement request. Business Solution Providers (BSPs) can create OBO WABAs and set mobility intents on eligible OBO WABAs; Technology Partners can only create onboarding requests, without OBO WABA management. Returns the existing request ID when the same partner and end business already have a pending request. Does not send a marketing message.

Input Parameters

string
required
End business portfolio ID that will receive the onboarding request, not the requesting partner’s ID. Obtain it from the end business’s Meta Business Suite business settings.
string
Optional WhatsApp Business Solution ID from your partner solution configuration. Associates the solution with the business agreement and OBO mobility intents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_PUBLISH_FLOWPublish 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.

Input Parameters

string
required
The unique identifier of the flow to publish. This is the ID assigned by Meta when the flow is created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_REGISTER_PHONERegister 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.

Input Parameters

string
required
6-digit PIN for two-step verification setup. The PIN must be exactly 6 digits.
object
Backup data for migrating existing WhatsApp Business accounts.
string
required
The ID of the phone number to register. This ID is provided when the phone number is added to your WhatsApp Business Account and can be found in WhatsApp Manager.
string
Must be ‘whatsapp’ to indicate WhatsApp Business messaging product.
string ("AE" | "AU" | "BH" | "BR" | "CA" | "CH" | "DE" | "GB" | "ID" | "IN" | "JP" | "KR" | "SG" | "ZA")
Data localization regions for message storage.
integer
Message retention period in minutes (deprecated in v21+). Only 60 minutes is allowed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_REJECT_BUSINESS_SOLUTIONReject a pending partnership or deactivation request for a Multi-Partner Solution. Requires an eligible partner app with access to the solution. Partnership rejection requires the requesting partner’s app ID. Rejection is permanent; rejected requests may need resubmission. An accepted partnership cannot be declined. Returns the rejection status and any available rejection details.

Input Parameters

string
required
Multi-Partner Solution ID from App Dashboard > WhatsApp > Partner solutions, solution management APIs, or the partner_solutions webhook’s solution_id.
string ("PARTNERSHIP_REQUEST" | "DEACTIVATION_REQUEST")
required
Type of pending request to reject: a partnership invitation or a solution deactivation request.
string
Requesting partner’s Meta app ID, obtained from the partner or solution details. Required for PARTNERSHIP_REQUEST; not used for DEACTIVATION_REQUEST.
string
Optional reason for rejecting the request (at most 500 characters).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_REJECT_GROUP_JOIN_REQUESTSReject pending requests to join a WhatsApp group, individually or in bulk. Requires a Groups API-eligible business number. Get join request IDs from the group’s open join requests or group_participants_update webhooks. Rejected users see the Request to join button again on the invite link. HTTP 200 can include partial failures: inspect rejected_join_requests, failed_join_requests and errors before treating every rejection as successful.

Input Parameters

string
required
Group ID from group creation webhooks or the active groups listing.
array
required
Join request IDs to reject. Obtain IDs from the group’s open join requests listing or group_participants_update webhooks.
string
Messaging product; must be whatsapp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_REJECT_SOLUTION_DEACTIVATIONReject a pending Multi-Partner Solution deactivation request. Keeps the solution ACTIVE and clears PENDING_DEACTIVATION to NONE, preserving its configuration, permissions, and ability to onboard clients. Partners are notified of the rejection. Requires an eligible solution partnership and a pending deactivation request; the multi-partner guide specifies solution-owner access. Returns solution state, optionally restricted by fields.

Input Parameters

string
Comma-separated response fields: id, name, status, status_for_pending_request, owner_app, owner_permissions. Omit for provider defaults: name,status,status_for_pending_request.
string
required
Multi-Partner Solution ID with a pending deactivation request. Find it in WHATSAPP_LIST_BUSINESS_SOLUTIONS, the App Dashboard’s Partner solutions panel, or a partner_solutions webhook’s solution_id.
boolean
required
Set to true to reject the pending deactivation request and keep the solution active.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_REMOVE_ASSIGNED_USERRemove an assigned user’s access from the WhatsApp Business Account bound to the connection. The user must be reassigned to regain access.

Input Parameters

string
required
The user ID of the person to remove from the WhatsApp Business Account. This must be a valid Facebook user ID that is currently assigned to the account.
string
Optional: WhatsApp Business Account ID to target. If not provided, uses the waba_id from your connection configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_REMOVE_GROUP_PARTICIPANTSRequest removal of one to eight WhatsApp group participants. Removed participants cannot rejoin via an invite link. Requires a Groups API-eligible business number and its whatsapp_business_messaging permission. HTTP 200 means the request was processed, not that every removal succeeded. Inspect any returned errors and group_participants_update webhooks for final per-participant outcomes; this action does not wait for webhooks.

Input Parameters

string
required
Group ID from group creation webhooks or the active groups listing.
array
required
One to eight phone numbers or WhatsApp user IDs to remove, each supplied as a user object.
string
Messaging product; must be whatsapp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_REQUEST_PREVERIFIED_NUMBER_CODERequest a verification code for a business-owned pre-verified phone number. Delivers a code using IVR, SMS, or VOICE during pre-verified number onboarding. Use the pre-verified phone number node ID, not an ordinary phone number ID. Submit the received code separately with WHATSAPP_VERIFY_PREVERIFIED_NUMBER_CODE. This action requests delivery; it does not complete verification.

Input Parameters

string
required
Verification message locale, such as en_US or en-US; extended locale codes are also supported. Unsupported languages fall back to en_US.
string
Optional User-Agent header identifying the client software.
string ("IVR" | "SMS" | "VOICE")
required
Delivery method for the verification code: IVR, SMS, or VOICE.
string
required
Pre-verified phone number node ID provided during pre-verification; find it in WhatsApp Business Account settings. This is not an ordinary WhatsApp Business phone number ID or a telephone number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_REQUEST_SOLUTION_DEACTIVATIONAsk the partner to deactivate an owned WhatsApp Multi-Partner Solution. The operation reference allows ACTIVE or INITIATED solutions; the guide describes owner-created ACTIVE solutions. Meta validates eligibility. Processing is asynchronous: the solution enters PENDING_DEACTIVATION and the partner is notified. It can still onboard clients until the partner accepts. Rejection leaves it ACTIVE; acceptance sets DEACTIVATED and stops client onboarding. Deactivated solutions cannot be edited. This submits the request only and does not accept the request or confirm final deactivation.

Input Parameters

string
Optional reason for requesting deactivation (at most 500 characters).
string
required
Multi-Partner Solution ID from creation, the partner_solutions webhook, or App Dashboard > WhatsApp > Partner solutions. You must be the solution owner.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_REQUEST_VERIFICATION_CODERequest an SMS or voice verification code for a WhatsApp Business phone number. Sends a code to the phone number as the first step of phone number verification. Submit the received code separately with WHATSAPP_VERIFY_CODE. This action does not verify the code or register the phone number for Cloud API messaging.

Input Parameters

string
required
Language locale for the verification message, for example ‘en_US’.
string
Optional User-Agent header identifying the client software.
string ("SMS" | "VOICE")
required
Method for delivering the verification code: SMS or VOICE.
string
required
WhatsApp Business phone number ID. Discover it with WHATSAPP_GET_PHONE_NUMBERS; this is not the phone number itself.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_SEND_CONTACTSSend contacts WhatsApp number. Note: The message will be delivered to the recipient only if they have initiated a conversation first.

Input Parameters

array
required
List of contacts to send. Each contact requires a name object with formatted_name, first_name, and last_name. Optional fields: addresses, birthday (YYYY-MM-DD), emails, org (company/department/title), and phones.
string
required
The phone number to send the contacts to, including the country code without the + sign.
string ("individual" | "group")
The type of recipient. ‘individual’ (default) targets a phone number; ‘group’ targets a WhatsApp group id supplied in to_number.
string
required
The phone number ID from which to send the contacts.
string
Optional WhatsApp message ID (wamid…) of the message to reply to. When provided, this contact card is sent as a quoted reply (context.message_id) in the conversation thread.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_SEND_ENCRYPTED_MESSAGESend a caller-encrypted WhatsApp message and return the encrypted response. Requires a registered business phone number with payload encryption enabled via POST /<Phone-Number-ID>/settings, and caller-side encryption/decryption with externally managed keys. Supply a pre-encrypted JWE containing the original /messages payload. Sending is irreversible. This action neither performs local cryptography nor decrypts the response or confirms delivery. Successful responses are encrypted; provider errors can be unencrypted.

Input Parameters

string
required
Registered sender WhatsApp Business phone number ID, discovered with WHATSAPP_GET_PHONE_NUMBERS. Payload encryption must already be enabled through POST /<Phone-Number-ID>/settings.
string
Messaging product; always whatsapp.
string
required
Pre-encrypted JWE string containing a payload with the original /messages structure. The caller must encrypt using provider-supported algorithms and manage keys externally. Forwarded exactly as supplied; no local encryption or JWE validation is performed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_SEND_INTERACTIVE_BUTTONSSend 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.

Input Parameters

array
required
List of 1-3 interactive buttons. Each button must have a unique ID and title.
string
required
Main message text explaining the purpose or question for the buttons (maximum 1024 characters).
string
required
Recipient’s phone number in international format without the + sign (e.g., ‘14155552345’ for a US number). The recipient must be a registered WhatsApp user and must have messaged your business within the last 24 hours.
Optional footer text displayed at the bottom of the message, below the buttons (maximum 60 characters).
string
Optional header text displayed at the top of the message (maximum 60 characters).
string
required
The WhatsApp Business phone number ID from which to send the message. Get this from the WHATSAPP_GET_PHONE_NUMBERS action.
string
Optional message ID to reply to. Use this to create a threaded conversation by replying to a specific previous message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_SEND_INTERACTIVE_LISTSend 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.

Input Parameters

array
required
Sections containing list items (maximum 10 sections, minimum 1 section).
string
required
Body text for the list message (up to 1024 characters).
string
required
The recipient’s phone number in international format without the + sign (e.g., ‘15551234567’ for a US number). Note: The recipient must have initiated a conversation with your WhatsApp Business account within the last 24 hours to receive this message.
string
required
Text for the list button (up to 20 characters).
Footer text for the list message (up to 60 characters).
string
Header text for the list message (up to 60 characters).
string
required
The Meta-assigned numeric ID for the WhatsApp Business phone number to send from. This is NOT the actual phone number itself - it is a numeric ID (e.g., ‘901139066420489’) assigned by Meta. Obtain it using WHATSAPP_GET_PHONE_NUMBERS action which returns the ‘id’ field for each phone number.
string
The ID of the message to reply to (optional).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_SEND_LOCATIONSend 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)

Input Parameters

string
required
The name or title of the location (e.g., ‘San Francisco City Hall’, ‘Golden Gate Bridge’). This will be displayed to the recipient.
string
required
The full address of the location (e.g., ‘1 Dr Carlton B Goodlett Pl, San Francisco, CA 94102’). This provides context to the recipient about the location.
string
required
The latitude coordinate of the location in decimal degrees format (e.g., ‘37.7749’ for San Francisco). Range: -90 to 90.
string
required
The longitude coordinate of the location in decimal degrees format (e.g., ‘-122.4194’ for San Francisco). Range: -180 to 180.
string
required
The recipient’s WhatsApp phone number in international format without the + sign or spaces (e.g., ‘14155238886’ for US number). The recipient must have a WhatsApp account registered with this number.
string
required
The WhatsApp Business phone number ID from which to send the location message. This is the ID of your WhatsApp Business phone number, not the phone number itself.
string
Optional WhatsApp message ID (wamid…) of the message to reply to. When provided, this location is sent as a quoted reply (context.message_id) in the conversation thread.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_SEND_MARKETING_MESSAGESend an approved marketing template through the Marketing Messages API. Requires MM onboarding, a registered business phone number and an approved marketing template. Cloud API fallback depends on product_policy and account settings. Accepts phone numbers or BSUIDs; acceptance does not imply delivery.

Input Parameters

string
Recipient WhatsApp phone number. Supply to or recipient; when both are supplied, to takes precedence.
string
required
Only template messages are supported by this endpoint.
object
Optional beta send-time max-price adjustment.
object
required
Approved marketing template and its variable parameters.
string
Recipient BSUID or parent BSUID obtained from WhatsApp webhooks. Used only when to is omitted. BSUID sends disable delivery optimization and cannot use dynamic-pricing templates.
string ("CLOUD_API_FALLBACK" | "STRICT")
CLOUD_API_FALLBACK allows Cloud API routing if MM onboarding is incomplete (provider default). STRICT disables fallback.
string
required
Marketing message recipient type; must be individual.
string
required
Registered sender business phone number ID, discovered with WHATSAPP_GET_PHONE_NUMBERS.
string
required
Messaging product; must be whatsapp.
boolean
Enable or disable sharing this message’s activity with Meta. Omit to use the account setting.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_SEND_MEDIASend a media message to a WhatsApp number using a media URL. The recipient must have texted first to receive the media.

Input Parameters

The publicly accessible HTTPS URL of the media file to send. The URL must be accessible by WhatsApp servers and serve the appropriate content-type header. For media uploads, use WHATSAPP_UPLOAD_MEDIA action to get a media ID and use WHATSAPP_SEND_MEDIA_BY_ID instead.
string
Optional caption text to accompany the media (max 1024 characters). Only supported for ‘image’, ‘video’, and ‘document’ media types. Captions are NOT supported for ‘audio’ and ‘sticker’ types.
string
required
The phone number to send the media to, including the country code without the + sign.
string ("audio" | "document" | "image" | "sticker" | "video")
required
The type of media to send. Options: ‘audio’ (voice messages), ‘document’ (PDFs, docs), ‘image’ (PNG, JPG), ‘sticker’ (WebP animated stickers), ‘video’ (MP4 videos). Note: Only ‘image’, ‘video’, and ‘document’ types support captions.
string
required
The Meta-assigned numeric ID for the WhatsApp Business phone number to send from. This is NOT the actual phone number itself - it is a numeric ID (e.g., ‘901139066420489’) assigned by Meta. Obtain it using WHATSAPP_GET_PHONE_NUMBERS action which returns the ‘id’ field for each phone number.
string
Optional WhatsApp message ID (wamid…) of the message to reply to. When provided, this media message is sent as a quoted reply (context.message_id) in the conversation thread.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_SEND_MEDIA_BY_IDSend 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.

Input Parameters

string
Caption for the media (not supported for audio and sticker).
string
Filename for document media.
string
required
The media ID from uploaded media (use upload_media action to get this ID).
string
required
The phone number to send the media to, including the country code without the + sign.
string ("audio" | "document" | "image" | "sticker" | "video")
required
The type of media to send: audio, document, image, sticker, or video.
string
required
The phone number ID from which to send the media.
string
The ID of the message to reply to (optional).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_SEND_MESSAGESend 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 test accounts, recipient numbers must be added to the test recipient list in Meta Business Suite before sending messages.

Input Parameters

string
required
The text content of the message to send. Supports Unicode characters including emojis. Maximum length: 4096 characters.
string
required
The recipient’s WhatsApp phone number in international format without the + sign (e.g., ‘14155551234’ for a US number). The number must be registered on WhatsApp.
string
Optional: The WhatsApp message ID (wamid) to reply to. When provided, this message will be sent as a reply to the specified message, creating a quoted reply thread. Leave empty to send a regular message.
boolean
Set to True to show a preview card for URLs in the message. When enabled, WhatsApp will fetch and display URL metadata (title, description, image) for the first URL in the message. Default: False.
string
required
The Meta-assigned numeric ID for the WhatsApp Business phone number to send from. This is NOT the actual phone number itself - it is a numeric ID (e.g., ‘712594308615206’) assigned by Meta. Obtain it using WHATSAPP_GET_PHONE_NUMBERS action which returns the ‘id’ field for each phone number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_SEND_TEMPLATE_MESSAGESend a template message to a WhatsApp number.

Input Parameters

string
required
The phone number to send the template message to, including the country code without the + sign.
array
Template components with parameters to fill template variables. Use ‘body’ type with text parameters for simple variable substitution.
string ("af" | "sq" | "ar" | "ar_EG" | "ar_AE" | "ar_LB" | "ar_MA" | "ar_QA" | "az" | "be_BY" | "bn" | "bn_IN" | "bg" | "ca" | "zh_CN" | "zh_HK" | "zh_TW" | "hr" | "cs" | "da" | "prs_AF" | "nl" | "nl_BE" | "en" | "en_GB" | "en_US" | "en_AE" | "en_AU" | "en_CA" | "en_GH" | "en_IE" | "en_IN" | "en_JM" | "en_MY" | "en_NZ" | "en_QA" | "en_SG" | "en_UG" | "en_ZA" | "et" | "fil" | "fi" | "fr" | "fr_BE" | "fr_CA" | "fr_CH" | "fr_CI" | "fr_MA" | "ka" | "de" | "de_AT" | "de_CH" | "el" | "gu" | "ha" | "he" | "hi" | "hu" | "id" | "ga" | "it" | "ja" | "kn" | "kk" | "rw_RW" | "ko" | "ky_KG" | "lo" | "lv" | "lt" | "mk" | "ms" | "ml" | "mr" | "nb" | "ps_AF" | "fa" | "pl" | "pt_BR" | "pt_PT" | "pa" | "ro" | "ru" | "sr" | "si_LK" | "sk" | "sl" | "es" | "es_AR" | "es_CL" | "es_CO" | "es_CR" | "es_DO" | "es_EC" | "es_HN" | "es_MX" | "es_PA" | "es_PE" | "es_ES" | "es_UY" | "sw" | "sv" | "ta" | "te" | "th" | "tr" | "uk" | "ur" | "uz" | "vi" | "zu")
The language code for the template.
string
required
The name of the template to be sent.
string
required
The phone number ID from which to send the template message.
string
Optional WhatsApp message ID (wamid…) of the message to reply to. When provided, this template message is sent as a quoted reply (context.message_id) in the conversation thread.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_SET_BUSINESS_ENCRYPTIONSet the RSA public key used to encrypt WhatsApp message payloads and data channel requests. Upload a PEM public key for a WhatsApp Business phone number. Only one public key is active per phone number; uploading a new key replaces the previous key. Keep the corresponding private key outside this action.

Input Parameters

string
required
WhatsApp Business phone number ID. Discover it with WHATSAPP_GET_PHONE_NUMBERS.
string
required
RSA public key in PEM format to upload and sign for payload encryption. Supply only the public key, never a private key. Replaces the phone number’s previous public key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_SET_OBO_MOBILITY_INTENTSet OBO mobility intent for a Multi-Partner Solution associated with a client WABA. For authorized solution providers/partners managing client accounts. Establishes On-Behalf-Of relationships and configures provider access and messaging mobility; settings may take a few minutes to propagate. The legacy OBO account ownership model is retired and replaced by partner-initiated account creation, but this operation remains in the official v23 spec. Confirm account eligibility with Meta; its presence in the spec does not guarantee availability for new OBO onboarding. Returns the provider’s success flag, intent ID and any failure explanation.

Input Parameters

object
required
OBO mobility intent configuration, including the required body waba_id.
string
required
Path WhatsApp Business Account ID; find in Business Manager or owned/shared WABA listings. Requires solution-provider access to the client WABA.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_SET_SOLUTION_MIGRATION_INTENTSet migration intent for a Multi-Partner Solution associated with a WABA. Requires an authorized solution partner with access to the WABA and eligible source/target solutions. Initiate, schedule, confirm, or cancel migration; Meta validates eligibility and pending state. This can change partner arrangements, trigger partner notifications, and execute migration at the scheduled time or immediately upon confirmation. A successful response records the intent, not proof that migration completed.

Input Parameters

object
required
Migration intent JSON body for the solution associated with this WABA.
string
required
WhatsApp Business Account ID from owned/shared WABA listings or WhatsApp Business Manager. Requires authorized solution-partner access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_SET_TWO_STEP_VERIFICATIONSet 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.

Input Parameters

string
required
New 6-digit two-step verification PIN. Must be exactly 6 digits.
string
required
The ID of the phone number whose two-step verification PIN should be set or reset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_SHARE_PREVERIFIED_NUMBERSShare a number from a business’s pre-verified phone number pool with a partner. Requires ownership or sharing rights to the pre-verified number and a valid partner business accessible to the requesting app. The number retains its original ownership. Business relationship and access-control policies must allow the share; this action does not assign business roles or verify a number.

Input Parameters

string
required
Business portfolio ID that owns or has sharing rights to the pre-verified number. Find it in Meta Business Manager or business management APIs.
string
required
Pre-verified phone number ID to share from the business’s pool. Discover it with WHATSAPP_LIST_PREVERIFIED_NUMBERS; the requesting business must own it or have sharing rights.
string
required
Partner business portfolio ID receiving access. Obtain it from the partner’s Meta Business Manager; it must identify a valid business accessible to the requesting app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_SUBSCRIBE_APPSubscribe your application to webhook notifications for the WhatsApp Business Account configured on the connection, using the configured app webhook settings.

Input Parameters

string
WhatsApp Business Account ID to subscribe to. If not provided, uses the WABA ID from auth headers.
string
Verification token for webhook security. This token will be used to verify webhook callbacks.
string
Custom webhook callback URL to override app default. Must be a valid HTTPS URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_UNBLOCK_USERSUnblock WhatsApp users so they can contact the business phone number again. Sends a DELETE with a JSON body. Inspect removed_users, failed_users and error: a successful HTTP response can contain partial or complete per-user failures.

Input Parameters

array
Users to unblock, at most 1,000 per request. The DELETE reference marks this body field optional; supply users to perform an unblock.
string
required
Meta-assigned business phone number ID, not its display phone number. Discover with WHATSAPP_GET_PHONE_NUMBERS.
string
Messaging product; use ‘whatsapp’. Optional in the endpoint reference.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_UNSUBSCRIBE_APPUnsubscribe your application from webhook events for the connection-bound WhatsApp Business Account, for example when cleaning up an integration. If an account ID is supplied, it must match the connection. A success result does not always confirm that the subscription was removed.

Input Parameters

string
WhatsApp Business Account ID to unsubscribe from. If not provided, uses the WABA ID from auth headers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_UPDATE_BUSINESS_ACCOUNTUpdate 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.

Input Parameters

string
The new name for the Flow.
string
required
The unique identifier of the Flow to update. Get this from the WHATSAPP_LIST_FLOWS action which returns the ‘id’ field for each flow.
array
List of categories to assign to the Flow (e.g., [‘OTHER’, ‘SIGN_UP’]).
string
The endpoint URI where the Flow will send data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_UPDATE_BUSINESS_ACCOUNT_SETTINGSUpdate a WhatsApp Business Account’s name or timezone identifier. Supply the WABA ID from WhatsApp Manager or the business management APIs. Omitted settings are left unchanged. This operation updates account settings, not WhatsApp Flow metadata.

Input Parameters

string
Updated name for the WhatsApp Business Account.
string
required
WhatsApp Business Account ID. Find it in WhatsApp Manager or through the business management APIs; this is not a Flow ID or phone number ID.
string
Updated timezone identifier for the WhatsApp Business Account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_UPDATE_BUSINESS_COMPLIANCE_INFOCreate or update regulatory compliance information for a WhatsApp Business phone number. Supply legal entity details and grievance officer and customer care contacts. Discover the phone number ID with WHATSAPP_GET_PHONE_NUMBERS.

Input Parameters

string
required
Legal business entity name (2–128 characters).
string ("LIMITED_LIABILITY_PARTNERSHIP" | "SOLE_PROPRIETORSHIP" | "PARTNERSHIP" | "PUBLIC_COMPANY" | "PRIVATE_COMPANY" | "OTHER")
required
Legal business entity type.
boolean
Whether officially registered; allowed only for OTHER or PARTNERSHIP.
string
required
WhatsApp Business phone number ID, not the phone number itself. Discover with WHATSAPP_GET_PHONE_NUMBERS or Business Manager.
string
required
Messaging product identifier; must be whatsapp.
string
Custom entity type; required for OTHER and forbidden for other entity types.
object
required
Customer care contact details; email is required.
object
required
Grievance officer contact details; name and email are required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_UPDATE_BUSINESS_PROFILEUpdate 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.

Input Parameters

string
The text to display in the business profile’s About section. Maximum 139 characters.
string
The contact email address of the business. Maximum 128 characters.
string
The address of the business. Maximum 256 characters.
string ("OTHER" | "AUTO" | "BEAUTY" | "APPAREL" | "EDU" | "ENTERTAIN" | "EVENT_PLAN" | "FINANCE" | "GROCERY" | "GOVT" | "HOTEL" | "HEALTH" | "NONPROFIT" | "PROF_SERVICES" | "RETAIL" | "TRAVEL" | "RESTAURANT" | "ALCOHOL" | "ONLINE_GAMBLING" | "PHYSICAL_GAMBLING" | "OTC_DRUGS")
The industry/vertical type of the WhatsApp Business account.
array
List of URLs associated with the business. Maximum 2 URLs allowed.
string
Description of the business. Maximum 256 characters.
string
required
The Meta-assigned numeric ID for the WhatsApp Business phone number. This is NOT the actual phone number - it is a numeric ID (e.g., ‘712594308615206’) assigned by Meta. Obtain it using WHATSAPP_GET_PHONE_NUMBERS action which returns the ‘id’ field for each phone number.
string
The messaging service used for the request. Must be set to ‘whatsapp’.
string
The handle of the profile picture generated from the Resumable Upload API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_UPDATE_BUSINESS_PROFILE_NODEUpdate a WhatsApp Business Profile directly by its profile node ID. Sends POST /{profile-id} with business details, contact information, industry vertical, websites, or a previously uploaded profile picture handle. Distinct from WHATSAPP_UPDATE_BUSINESS_PROFILE, which updates the /{phone-number-id}/whatsapp_business_profile edge. Returns the provider’s optional profile ID and success flag without synthesizing success.

Input Parameters

string
Business profile about text.
string
Business contact email address.
string
Physical business address.
string ("ALCOHOL" | "APPAREL" | "AUTO" | "BEAUTY" | "EDU" | "ENTERTAIN" | "EVENT_PLAN" | "FINANCE" | "GOVT" | "GROCERY" | "HEALTH" | "HOTEL" | "MATRIMONY_SERVICE" | "NONPROFIT" | "NOT_A_BIZ" | "ONLINE_GAMBLING" | "OTHER" | "OTC_DRUGS" | "PHYSICAL_GAMBLING" | "PROF_SERVICES" | "RESTAURANT" | "RETAIL" | "TRAVEL" | "UNDEFINED")
Business industry vertical classification.
array
Website URLs associated with the business.
string
Business description text.
string
required
Messaging service used for the request; must be whatsapp.
string
Profile picture handle obtained through the Resumable Upload API.
string
required
WhatsApp Business Profile node ID, found in WhatsApp Business Manager or through business management APIs. Supply the profile ID, not a phone number ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_UPDATE_COMMERCE_SETTINGSSet 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.

Input Parameters

boolean
Enable or disable the shopping cart feature. When enabled, customers can add items to a cart and checkout directly in WhatsApp.
string
required
The Meta-assigned numeric ID for the WhatsApp Business phone number (e.g., ‘712594308615206’). This is NOT the actual phone number - it is a numeric ID assigned by Meta. Obtain it using WHATSAPP_GET_PHONE_NUMBERS action which returns the ‘id’ field for each phone number.
boolean
Make the product catalog visible to customers. When enabled, customers can browse your products directly in WhatsApp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_UPDATE_FLOW_JSONUpdate the Flow JSON configuration for an existing WhatsApp Flow by uploading a file or inline JSON. The response may include validation errors; JSON error responses can also be returned without raising an HTTP error.

Input Parameters

string
required
The unique identifier of the flow. This is the ID assigned by Meta when the flow is created.
string
The asset type being uploaded. Must be ‘FLOW_JSON’ for Flow JSON updates.
string
Inline JSON content to upload as a string. Provide either file_to_upload or raw_content.
object
The flow.json file to upload. The file name should be ‘flow.json’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_UPDATE_GROUPUpdate an existing WhatsApp group’s subject, description, or photo. Requires an eligible Official Business Account using Cloud API. Omitted settings are not sent. Supplying file uploads the photo using multipart form data; otherwise settings are sent as JSON. HTTP acceptance does not establish that every setting changed: inspect group_settings_update webhooks for success, partial failure, or total failure.

Input Parameters

object
Group profile picture to upload as multipart file data. Must be JPEG, maximum 5 MB, square, and at least 192 by 192 pixels. Omit to send a JSON-only settings update.
string
New group subject, 1–128 characters. Omit to leave unchanged.
string
required
WhatsApp group ID. Obtain it from WHATSAPP_LIST_GROUPS or the group creation lifecycle webhook.
string
New group description, at most 2048 characters. Omit to leave unchanged.
string
Messaging product; must be whatsapp.
string
Provider-documented profile_picture_file path, forwarded unchanged as text. For an actual binary photo upload, use file instead; no path is inferred from the uploaded file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_UPDATE_OFFICIAL_BUSINESS_ACCOUNT_STATUSSubmit OBA application information or update application data for a phone number. Sends business website, country, and optional notability information to the Official Business Account application/update endpoint. This does not directly set approval status. Although the reference mentions withdrawal and resubmission, it documents no intent selector; this action exposes only the documented payload. Meta enforces eligibility and application-state transitions.

Input Parameters

string
required
WhatsApp Business phone number ID, not the telephone number. Obtain the id from WHATSAPP_GET_PHONE_NUMBERS.
string
Primary language used by the business.
Supporting URLs demonstrating business notability; provide 5 to 10 links when supplied.
string
required
Official business website URL.
string
Parent business or brand name.
string
required
Primary country where the business operates.
string
Additional information supporting the OBA application.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_UPDATE_SETTINGSUpdate 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.

Input Parameters

object
Calling feature settings.
string
required
The WhatsApp Business phone number ID (e.g., ‘712594308615206’). Get this from the WHATSAPP_GET_PHONE_NUMBERS action.
object
Payload encryption settings.
object
User identity change settings.
object
Storage configuration settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_UPLOAD_FILE_CHUNKUpload raw file bytes to a resumable upload session and return its file handle. Create the session first with WHATSAPP_CREATE_UPLOAD_SESSION. To resume, retrieve WHATSAPP_GET_UPLOAD_OFFSET and supply the remaining bytes with that offset. The connected account must provide the user access token required by the Resumable Upload API.

Input Parameters

object
required
File containing the bytes to upload. For a resumed upload, supply only the remaining bytes starting at file_offset; this action does not slice the file.
integer
Byte offset in the upload session: 0 for a new upload, or the file_offset returned by WHATSAPP_GET_UPLOAD_OFFSET when resuming.
string
required
Session ID returned by WHATSAPP_CREATE_UPLOAD_SESSION. Pass the returned id, including upload: and any ?sig= signature, unchanged; a bare session ID is also accepted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_UPLOAD_MEDIAUpload 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, DOC, DOCX, PPT, PPTX, XLS, XLSX (max 100MB) - Stickers: WebP (max 500KB, 512x512 pixels)

Input Parameters

string ("image" | "video" | "audio" | "document" | "sticker")
required
Type of media being uploaded: image, video, audio, document, or sticker.
object
required
Media file to upload to WhatsApp (max 16MB for most types, 100MB for videos).
string
required
The phone number ID to upload media for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_UPSERT_MESSAGE_TEMPLATECreate 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.

Input Parameters

string
required
Unique template name. Must be lowercase, alphanumeric with underscores only. Maximum 512 characters. Example: ‘order_confirmation_v1’.
string
WhatsApp Business Account ID. If not provided, uses the waba_id from your connection configuration.
string ("AUTHENTICATION" | "MARKETING" | "UTILITY")
required
Template category. AUTHENTICATION: for OTP/verification codes. MARKETING: for promotional content (requires opt-in). UTILITY: for transactional updates like order status, appointments.
string
required
Template language code in ISO 639-1 format with country code. Examples: ‘en_US’ (US English), ‘es_ES’ (Spanish), ‘pt_BR’ (Brazilian Portuguese).
array
required
List of template components. Must include at least one BODY component. Can optionally include one HEADER, one FOOTER, and one BUTTONS component.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_VERIFY_CODEVerify 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 verification by submitting the 6-digit code received via SMS or voice call. Note: This action verifies a phone number that has been pre-verified and is awaiting OTP confirmation.

Input Parameters

string
required
6-digit verification code received via SMS or voice call. The code must be exactly 6 digits.
string
required
The ID of the phone number to verify. This ID is provided when the phone number is added to your WhatsApp Business Account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_VERIFY_PREVERIFIED_NUMBER_CODEVerify an OTP for a pre-verified phone number to complete verification. First request a code with WHATSAPP_REQUEST_PREVERIFIED_NUMBER_CODE, then submit the received code with the same pre-verified phone number node ID. This updates the number’s verification status. Expired, invalid, or reused codes fail.

Input Parameters

string
required
Numeric verification code received via SMS or voice after requesting a code with WHATSAPP_REQUEST_PREVERIFIED_NUMBER_CODE. Codes expire and can only be used once.
string
Optional User-Agent header identifying the client software.
string
required
Pre-verified phone number node ID returned when creating the pre-verified number; find it in WhatsApp Business Manager or the pre-verified phone number listing. This is not a telephone number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: WHATSAPP_WHO_AM_IReturn the identity (name) of the connected WhatsApp (Meta) account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not

Triggers

Slug: WHATSAPP_MESSAGE_STATUS_UPDATED_TRIGGERType: pollTriggers when a WhatsApp message status changes.IMPORTANT LIMITATION: WhatsApp Cloud API does not provide a native polling endpoint for message status. Status updates are ONLY delivered via webhooks in real-time. This trigger cannot directly poll the WhatsApp API for status updates.This trigger will return empty results as WhatsApp does not support this operation. To track message status updates, you must:
  1. Set up a webhook endpoint to receive status notifications from WhatsApp
  2. Store the webhook data in your own database
  3. Use a different mechanism to query your stored webhook data
For more information, see:

Configuration

number
Deprecated: use polling_interval on the trigger instance instead. Minutes between checks for new events.
integer
Maximum number of status updates to retrieve in each poll (1-100).
string
required
The Meta-assigned numeric ID for the WhatsApp Business phone number to monitor. This is NOT the actual phone number itself - it is a numeric ID (e.g., ‘712594308615206’) assigned by Meta. Obtain it using WHATSAPP_GET_PHONE_NUMBERS action which returns the ‘id’ field for each phone number.
string
Optional: Filter by specific status. Valid values: ‘sent’, ‘delivered’, ‘read’, ‘failed’. Leave empty to monitor all status changes.

Payload

string
Type of event that occurred
string
required
The phone number ID that sent the message
object
required
The message status update information