WhatsApp Business (API Token)
Send and receive WhatsApp messages via Meta's official WhatsApp Business Cloud API using your own Meta app credentials.
Authentication
This connector uses Token-based authentication.
info
Set up your connection in the Abstra Console before using it in your workflows.
How to use
Using the Smart Chat
Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".
Using the Web Editor
from abstra.connectors import run_connection_action
result = run_connection_action(
connection_name="your_connection_name",
action_name="your_action_name",
params={
"param1": "value1",
"param2": "value2"
})
Available Actions
This connector provides 114 actions:
| Action | Purpose | Parameters |
|---|---|---|
| get_by_version_by_application_id_connected_client_businesses | Retrieve a list of client businesses connected to the specified application. Use Cases: - Monitor application-business client relationships - Verify connected business configurations - Retrieve business connection status and details - Manage client business access and permissions Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Business connection data can be cached for moderate periods, but status information may change. I | Version (string) Application-ID (string) User-Agent (string) Authorization (string) required fields (string) limit (integer) after (string) before (string) |
| post_by_version_by_application_id_whatsapp_business_solution | Create a new Multi-Partner Solution that defines permission distribution between a solution owner app and a partner app for WhatsApp Business messaging collaboration. Permission Logic: - Only one partner owner or partner app can have MESSAGING permission - At least one partner must have MESSAGING permission - Both partners automatically receive default solution partner permissions - Empty permission arrays indicate no configurable permissions for that partner Solution Lifecycle: - Solutions | Version (string) Application-ID (string) User-Agent (string) Authorization (string) required data: { . owner_permissions (array) . partner_app_id (string) . partner_permissions (array) . solution_name (string) } (object) required |
| get_by_version_by_application_id_whatsapp_business_solutions | Retrieve all WhatsApp Business Multi-Partner Solutions associated with the specified application. This includes both solutions owned by the application and solutions where the application acts as a partner. Use Cases: - Retrieve all solutions for an application's portfolio management - Filter solutions by ownership role owner vs partner - Monitor solution lifecycle and status changes across multiple solutions - Verify solution configuration before business onboarding operations - Check pending | Version (string) Application-ID (string) User-Agent (string) Authorization (string) required role (string) fields (string) limit (integer) after (string) before (string) |
| post_by_version_by_business_id_add_phone_numbers | Add a preverified phone number to a WhatsApp Business Account. This endpoint is used by Partners to create a pool of Partner owned numbers that end clients can purchase. Use Cases: - Add new phone numbers to scale messaging operations - Set up phone numbers for different business locations - Manage phone number inventory for business messaging - Configure phone numbers for specific messaging workflows Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponen | Version (string) Business-ID (string) User-Agent (string) Authorization (string) required data: { . phone_number (string) } (object) required |
| get_by_version_by_business_id | Endpoint reference: Businesshttps://developers.facebook.com/docs/marketing-api/reference/business/ | Version (string) Business-ID (string) User-Agent (string) Authorization (string) required fields (string) |
| get_by_version_by_business_id_preverified_numbers | Retrieve pre-verified phone numbers available for use with the specified business. This endpoint provides information about phone numbers that have been pre-verified and are ready for immediate use with WhatsApp Business messaging operations. Use Cases: - Retrieve available pre-verified phone numbers for business messaging setup - Check verification status and availability of phone numbers - Monitor pre-verified phone number inventory - Validate phone number options before WhatsApp Business Acc | Version (string) Business-ID (string) User-Agent (string) Authorization (string) required fields (string) limit (integer) after (string) before (string) verification_status (string) availability_status (string) country_code (string) |
| get_by_version_by_business_id_client_whatsapp_business_accounts | Retrieve a list of WhatsApp Business Accounts that have been shared with the specified business. Use Cases: - Monitor shared WABA relationships and permissions - Verify WABA configuration and status information - Retrieve WABA details for business integrations - Manage multi-business WhatsApp messaging setups Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: WABA information can be cached for moderate periods, but status inf | Version (string) Business-ID (string) User-Agent (string) Authorization (string) required fields (string) business_type (array) limit (integer) after (string) before (string) find (string) |
| post_by_version_by_business_id_onboard_partners_to_mm_lite | Send a request from the partner to onboard an end business to MM Lite. This creates a business agreement request and sets OBO mobility intents on eligible WhatsApp Business Accounts. Business Flow: 1. Validates partner business and app permissions 2. Checks end business eligibility for MM Lite 3. Identifies eligible shared WABAs and OBO WABAs 4. Sets mobility intents on eligible OBO WABAs BSPs only 5. Creates business agreement request 6. Returns request ID for tracking BSP vs TP Behavior: - | Version (string) Business-ID (string) User-Agent (string) Authorization (string) required solution_id (string) |
| get_by_version_by_business_id_owned_whatsapp_business_accounts | Retrieve WhatsApp Business Accounts owned by the specified business. This endpoint provides comprehensive information about all WABAs owned by the business, including account details, configuration, and status information. Use Cases: - Retrieve all WhatsApp Business Accounts owned by a business - Filter accounts by business type - Find specific accounts by ID - Monitor business portfolio of WhatsApp Business Accounts - Manage account access and permissions across multiple WABAs Rate Limiting: | Version (string) Business-ID (string) User-Agent (string) Authorization (string) required business_type (array) after (string) first (integer) before (string) last (integer) find (string) |
| post_by_version_by_business_id_share_preverified_numbers | Share a pre-verified phone number with another business entity, granting specified permissions for collaborative WhatsApp Business messaging operations. Use Cases: - Enable partner businesses to use your pre-verified phone numbers for messaging - Share phone number resources between parent and subsidiary businesses - Facilitate multi-business WhatsApp integrations with shared phone number access - Establish temporary or permanent phone number sharing relationships Business Logic: - Only busi | Version (string) Business-ID (string) User-Agent (string) Authorization (string) required data: { . preverified_id (string) . partner_business_id (string) } (object) required |
| get_by_version_by_phone_number_id_block_users | - Guide: Block Usershttps://developers.facebook.com/docs/business-messaging/whatsapp/block-users - Endpoint reference: GET WhatsApp Buiness Phone Number block_usershttps://developers.facebook.com/docs/graph-api/reference/whats-app-business-account-to-number-current-status/block_users/ Reading | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required Content-Type (string) required |
| post_by_version_by_phone_number_id_block_users | - Guide: Block Usershttps://developers.facebook.com/docs/business-messaging/whatsapp/block-users - Endpoint reference: POST WhatsApp Buiness Phone Number block_usershttps://developers.facebook.com/docs/graph-api/reference/whats-app-business-account-to-number-current-status/block_users/ Creating | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required Content-Type (string) required data: { . block_users (array) . messaging_product (string) } (object) required |
| delete_by_version_by_phone_number_id_block_users | - Guide: Block Usershttps://developers.facebook.com/docs/business-messaging/whatsapp/block-users - Endpoint reference: DELETE WhatsApp Buiness Phone Number block_usershttps://developers.facebook.com/docs/graph-api/reference/whats-app-business-account-to-number-current-status/block_users/ Deleting | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required Content-Type (string) required data: { . block_users (array) . messaging_product (string) } (object) required |
| get_by_version_by_phone_number_id_call_permissions | Check whether you have permission to call a WhatsApp user and what actions are available. This endpoint returns the current permission status for calling a specific user, along with available actions and their limits. Permission Status: - granted: You have active permission to call this user - pending: A permission request has been sent but not yet approved - denied: The user has denied call permissions - expired: Previous permission has expired Available Actions: - start_call: Initiate a new | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required Content-Type (string) required user_wa_id (string) required |
| post_by_version_by_phone_number_id_calls | Use this endpoint to initiate, accept, reject, or terminate WhatsApp calls. For initiating or managing a call: Send a POST request with the appropriate action connect, pre_accept, accept, reject, terminate. For terminating a call: Send a POST request with action 'terminate' and the call_id. Note: Response with error code 138006 indicates a lack of a call request permission for this business number from the WhatsApp user. | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required Content-Type (string) required data (undefined) required |
| post_by_version_by_phone_number_id_groups | Create a new group and get an invite link | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required Content-Type (string) required data: { . messaging_product (string) . subject (string) . description (string) . join_approval_mode (string) } (object) required |
| get_by_version_by_phone_number_id_groups | Retrieve a list of active groups for a given business phone number | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required Content-Type (string) required limit (integer) after (string) before (string) |
| post_by_version_by_phone_number_id_marketing_messages | Send marketing template messages using pre-approved templates. Supports optional product policy controls and message activity sharing settings. | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required Content-Type (string) required data: { . messaging_product (string) . recipient_type (string) . to (string) . type (string) . template . product_policy (string) . message_activity_sharing (boolean) } (object) required |
| post_by_version_by_phone_number_id_media | This request uploads an image as .jpeg. The parameters are specified as form-data in the request body. | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required data: { . file (string) . messaging_product (string) } (object) required |
| post_by_version_by_phone_number_id_messages | Send Message. | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required Content-Type (string) required data (undefined) required |
| get_by_version_by_phone_number_id_message_qrdls | Retrieve all message QR codes for a phone number, sorted by creation time newest first. Supports field selection, filtering by code, cursor-based pagination, and QR image generation. | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required fields (string) code (string) limit (integer) after (string) before (string) |
| post_by_version_by_phone_number_id_message_qrdls | Create a new QR code without code parameter or update existing QR code with code parameter. Supports optional QR image generation in PNG or SVG format. | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required Content-Type (string) required data (undefined) required |
| get_by_version_by_phone_number_id_message_qrdls_by_qr_code_id | Retrieve details for a specific QR code by its unique identifier. Supports field selection and QR image generation. Response returns QR code in data array for consistency. | Version (string) Phone-Number-ID (string) QR-Code-ID (string) User-Agent (string) Authorization (string) required fields (string) |
| delete_by_version_by_phone_number_id_message_qrdls_by_qr_code_id | Permanently delete a specific QR code. Once deleted, the QR code and deep link become invalid. Deletion cannot be undone and affects any existing marketing materials using the QR code. | Version (string) Phone-Number-ID (string) QR-Code-ID (string) User-Agent (string) Authorization (string) required |
| post_by_version_by_phone_number_id_messages_encrypted | Send encrypted messages using JWE JSON Web Encryption format. This endpoint provides an additional layer of security on top of existing standard TLS/SSL by accepting pre-encrypted message payloads and returning encrypted responses. Important Notes: - Only successful responses will be encrypted - Error responses will be returned unencrypted if the underlying JSON is incorrectly formatted - Payload encryption must be enabled for the phone number using the POST /Phone-Number-ID/settings endpoint - | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required Content-Type (string) required data: { . messaging_product (string) . encrypted_contents (string) } (object) required |
| get_by_version_by_phone_number_id_official_business_account | Retrieve the Official Business Account OBA status and related information for a WhatsApp Business Account phone number. Use Cases: - Check current OBA verification status - Monitor OBA application progress - Retrieve status messages for business account verification - Validate business credibility status Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: OBA status information can be cached for moderate periods, but status may c | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required fields (string) |
| post_by_version_by_phone_number_id_official_business_account | Update or modify the Official Business Account OBA status for a WhatsApp Business Account phone number. This endpoint allows businesses to submit new applications, withdraw existing applications, or resubmit after addressing rejection reasons. Use Cases: - Submit initial Official Business Account application - Withdraw pending OBA application - Resubmit OBA application after addressing rejection feedback - Update application data for pending applications Application Data Requirements: When sub | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required data: { . business_website_url (string) . primary_country_of_operation (string) . primary_language (string) . parent_business_or_brand (string) . supporting_links (array) . additional_supporting_information (string) } (object) required |
| get_by_version_by_phone_number_id | Retrieve comprehensive information about a WhatsApp Business phone number using its unique ID CSID. This endpoint provides phone number status, verification details, quality metrics, and configuration information. Core Information Returned: - Phone number ID and display format - Verification status and verified business name - Quality rating based on message delivery performance - Code verification status for two-step verification - Display name certification status when requested Quality Rati | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required fields (string) |
| post_by_version_by_phone_number_id | Update the status and configuration of a WhatsApp Business Account phone number. This endpoint supports comprehensive phone number management including status updates, webhook configuration, security settings, and business profile management. Supported Operations: - Update connection status between WhatsApp Business Account and phone number - Configure webhook endpoints for message delivery notifications - Set up two-step verification and security notifications - Update display names for name v | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required data: { . connection_status . webhook_url (string) . whatsapp_business_api_data . pin (string) . search_visibility . webhook_configuration . new_display_name (string) . username (string) } (object) required |
| post_by_version_by_phone_number_id_deregister | Deregister a WhatsApp Business phone number from the Facebook Hosted System. This operation removes the phone number from the WhatsApp Business Platform and makes it available for re-registration if needed. Important Notes: - Phone number must be currently linked in Facebook Hosted System - Phone number must be registered on the WhatsApp Business Platform - Cannot deregister phone numbers associated with SMB accounts - Rate limiting is enforced to prevent abuse - Deregistration triggers activi | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required |
| get_by_version_by_phone_number_id_message_history | Retrieve paginated message history for a WhatsApp Business Account phone number, including delivery status events, timestamps, and webhook update information. Use Cases: - Track message delivery status and events - Monitor webhook delivery and update states - Retrieve historical message delivery information - Debug message delivery issues and webhook failures Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Message history | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required message_id (string) fields (string) limit (integer) after (string) before (string) |
| post_by_version_by_phone_number_id_register | Register a WhatsApp Business phone number for messaging capabilities and enable two-step verification. This is a required step before sending messages through the WhatsApp Business Cloud API. Registration Process: 1. Phone number must be in UNVERIFIED status 2. Provide a 6-digit PIN for two-step verification 3. Optionally provide backup data for account migration 4. Registration activates messaging capabilities Migration Support: For migrating from on-premises WhatsApp Business API, include | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required data: { . messaging_product (string) . pin (string) . backup . data_localization_region . meta_store_retention_minutes (integer) } (object) required |
| post_by_version_by_phone_number_id_request_code | Request a verification code for a WhatsApp Business phone number via SMS or voice call. This is the first step in the phone number verification process. Use Cases: - Initial verification of newly added phone numbers - Re-verification when phone number status requires it - Switching between SMS and voice verification methods Rate Limiting: Standard Graph API rate limits apply. Additional rate limiting may be enforced for verification code requests to prevent abuse. Security: Verification code | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required Content-Type (string) required data: { . code_method (string) . language (string) } (object) required |
| get_by_version_by_phone_number_id_settings | Retrieve current settings for a WhatsApp Business phone number. Returns calling settings, payload encryption settings, and data storage configurations. | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required Content-Type (string) required include_sip_credentials (boolean) |
| post_by_version_by_phone_number_id_settings | Update various settings for a WhatsApp Business phone number. You can configure calling settings, user identity change settings, payload encryption, and data storage configurations. Only one feature setting can be specified per request. | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required Content-Type (string) required data (object) required |
| post_by_version_by_phone_number_id_verify_code | Verify a phone number verification code for a WhatsApp Business Account phone number. This endpoint is used to complete the phone number verification process by submitting the verification code received via SMS or voice call. Use Cases: - Complete phone number verification during initial setup - Verify phone number ownership for messaging capabilities - Finalize phone number registration process - Complete phone number migration verification Rate Limiting: Verification attempts are rate-limi | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required Content-Type (string) required data: { . code (string) } (object) required |
| get_by_version_by_phone_number_id_whatsapp_business_encryption | Retrieve the current business public key and its signature verification status. This endpoint returns the public key that is currently configured for encrypting message payloads and indicates whether the stored signature is valid or has a mismatch. Use Cases: - Verify current encryption configuration - Check public key signature validation status - Retrieve public key for client-side encryption setup - Monitor encryption key status for security compliance Rate Limiting: Standard Graph API rat | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required fields (string) |
| post_by_version_by_phone_number_id_whatsapp_business_encryption | Upload and configure a business public key for message payload encryption. This endpoint accepts a business public key in PEM format, validates it, and stores it with a cryptographic signature for future use in encrypting message payloads and data channel requests. Use Cases: - Initial setup of encryption for WhatsApp Business messaging - Update existing public key for key rotation - Enable secure payload encryption for sensitive business communications - Configure encryption keys for complian | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required |
| get_by_version_by_phone_number_id_whatsapp_business_profile | Retrieve comprehensive information about a WhatsApp Business Profile, including business details, contact information, and profile settings. Use Cases: - Retrieve current business profile information - Check business contact details and settings - Verify business vertical and website information - Get profile picture URL and about section Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Business profile information can be c | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required Content-Type (string) required fields (string) |
| post_by_version_by_phone_number_id_whatsapp_business_profile | Update WhatsApp Business Profile information including business details, contact information, and profile settings. Use Cases: - Update business description and contact information - Modify business address and website information - Change business vertical classification - Update profile picture using Resumable Upload API - Update profile picture and about section Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Profile Picture Upd | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required Content-Type (string) required data: { . messaging_product (string) . about (string) . address (string) . description (string) . email (string) . profile_picture_handle (string) . websites (array) . vertical } (object) required |
| get_by_version_by_phone_number_id_whatsapp_commerce_settings | - Guide: Sell Products and Serviceshttps://developers.facebook.com/docs/business-messaging/whatsapp/catalogs/sell-products-and-services Cloud API - Guide: Sell Products and Serviceshttps://developers.facebook.com/docs/whatsapp/on-premises/guides/commerce-guides On-Premises API - Endpoint reference: WhatsApp Business Phone Number WhatsApp Commerce Settingshttps://developers.facebook.com/docs/graph-api/reference/whats-app-business-account-to-number-current-status/whatsapp_commerce_settings | Version (string) Phone-Number-ID (string) |
| post_by_version_by_phone_number_id_whatsapp_commerce_settings | - Guide: Sell Products and Serviceshttps://developers.facebook.com/docs/business-messaging/whatsapp/catalogs/sell-products-and-services Cloud API - Guide: Sell Products and Serviceshttps://developers.facebook.com/docs/whatsapp/on-premises/guides/commerce-guides On-Premises API - Endpoint reference: WhatsApp Business Phone Number WhatsApp Commerce Settingshttps://developers.facebook.com/docs/graph-api/reference/whats-app-business-account-to-number-current-status/whatsapp_commerce_settings | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required is_cart_enabled (string) is_catalog_visible (string) |
| get_by_version_by_phone_number_id_business_compliance_info | Retrieve comprehensive business compliance information for a WhatsApp Business Account phone number, including entity details, registration status, and required contact information for regulatory compliance. Use Cases: - Retrieve business compliance information for regulatory reporting - Verify business entity registration status and contact details - Access grievance officer and customer care information - Support compliance audits and regulatory verification processes Rate Limiting: Standa | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required fields (string) |
| post_by_version_by_phone_number_id_business_compliance_info | Create or update comprehensive business compliance information for a WhatsApp Business Account phone number, including entity details, registration status, and required contact information for regulatory compliance. Use Cases: - Set business compliance information for regulatory reporting - Update business entity registration status and details - Configure grievance officer and customer care contact information - Ensure compliance data accuracy for regulatory purposes - Support compliance setu | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required data: { . messaging_product (string) . entity_name (string) . entity_type . entity_type_custom (string) . is_registered (boolean) . grievance_officer_details . customer_care_details } (object) required |
| post_by_version_by_group_id_invite_link | Create a new group invite link | Version (string) group_id (string) User-Agent (string) Authorization (string) required Content-Type (string) required data: { . messaging_product (string) } (object) required |
| delete_by_version_by_group_id_invite_link | Delete an existing group invite link | Version (string) group_id (string) User-Agent (string) Authorization (string) required Content-Type (string) required data: { . messaging_product (string) } (object) required |
| get_by_version_by_group_id_join_requests | Get a list of open join requests for a group | Version (string) group_id (string) User-Agent (string) Authorization (string) required |
| post_by_version_by_group_id_join_requests | Approve one or more join requests | Version (string) group_id (string) User-Agent (string) Authorization (string) required Content-Type (string) required data: { . messaging_product (string) . join_requests (array) } (object) required |
| delete_by_version_by_group_id_join_requests | Reject one or more join requests | Version (string) group_id (string) User-Agent (string) Authorization (string) required Content-Type (string) required data: { . messaging_product (string) . join_requests (array) } (object) required |
| post_by_version_by_group_id_participants | Add participants to group | Version (string) group_id (string) User-Agent (string) Authorization (string) required Content-Type (string) required data: { . messaging_product (string) . participants (array) } (object) required |
| delete_by_version_by_group_id_participants | Remove participants from group | Version (string) group_id (string) User-Agent (string) Authorization (string) required Content-Type (string) required data: { . messaging_product (string) . participants (array) } (object) required |
| get_by_version_by_group_id | Retrieve metadata about a single group | Version (string) group_id (string) User-Agent (string) Authorization (string) required fields (string) |
| delete_by_version_by_group_id | Delete the group and remove all participants, including the business | Version (string) group_id (string) User-Agent (string) Authorization (string) required Content-Type (string) required |
| post_by_version_by_group_id | Update the subject, description, and photo of a group | Version (string) group_id (string) User-Agent (string) Authorization (string) required Content-Type (string) required data: { . messaging_product (string) . subject (string) . description (string) . profile_picture_file (string) } (object) required |
| get_by_version_by_media_id | To retrieve your media’s URL, make a GET call to /Media-ID. Use the returned URL to download the media file. Note that clicking this URL i.e. performing a generic GET will not return the media; you must include an access token. For more information, see Download Mediahttps://developers.facebook.com/docs/business-messaging/whatsapp/business-phone-numbers/media download-media. You can also use the optional query ?phone_number_id for Retrieve Media URL and Delete Media. This parameter checks to ma | Version (string) Media-ID (string) User-Agent (string) Authorization (string) required phone_number_id (string) |
| delete_by_version_by_media_id | To delete media, make a DELETE call to the ID of the media you want to delete. Prerequisites - User Access Tokenhttps://developers.facebook.com/docs/facebook-login/access-tokens usertokens with whatsapp_business_messaging permission - Media object ID from either uploading media endpoint or media message Webhooks | Version (string) Media-ID (string) User-Agent (string) Authorization (string) required Content-Type (string) required phone_number_id (string) |
| get_by_version_by_media_url | Download media files using URLs obtained from media retrieval endpoints. Requires User Access Token with whatsapp_business_messaging permission. Media URLs expire after 5 minutes and must be re-retrieved if expired. Returns binary content with appropriate MIME type headers. | Version (string) Media-URL (string) |
| get_by_version_by_message_history_id_events | Retrieve paginated message delivery status events for a specific message history entry, including delivery status occurrences, timestamps, and application information. Use Cases: - Track detailed message delivery status events and transitions - Monitor delivery status occurrence timestamps - Retrieve application information for delivery events - Debug message delivery issues and status changes Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential b | Version (string) Message-History-ID (string) User-Agent (string) Authorization (string) required status_filter (string) fields (string) limit (integer) after (string) before (string) |
| get_by_version_by_migration_intent_id | Retrieve comprehensive details about a WhatsApp Business Account migration intent, including its current status and migration information. Use Cases: - Monitor migration intent lifecycle and status changes - Verify migration intent configuration and current state - Check migration progress and completion status - Retrieve migration intent details for business workflows Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Migrat | Version (string) Migration-Intent-ID (string) User-Agent (string) Authorization (string) required fields (string) |
| get_by_version_by_pre_verified_phone_number_id | Retrieve details about a specific pre-verified phone number, including validation status, formatting information, and any associated error messages. Use Cases: - Check validation status of a pre-verified phone number - Retrieve formatted display version of the phone number - Get country code and formatting information - Troubleshoot validation errors Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Phone number details can | Version (string) Pre-Verified-Phone-Number-ID (string) User-Agent (string) Authorization (string) required fields (string) |
| delete_by_version_by_pre_verified_phone_number_id | Delete a pre-verified phone number from the system. This operation removes the phone number from your pre-verified list and cannot be undone. Use Cases: - Remove phone numbers that are no longer needed - Clean up invalid or incorrect pre-verified phone numbers - Manage phone number lifecycle and cleanup Important Notes: - This operation is irreversible - Deleted phone numbers cannot be recovered - Ensure the phone number is not in active use before deletion Rate Limiting: Standard Graph AP | Version (string) Pre-Verified-Phone-Number-ID (string) User-Agent (string) Authorization (string) required |
| get_by_version_by_pre_verified_phone_number_id_partners | Retrieve the list of partner businesses that have been granted access to a specific WhatsApp Business Pre-Verified Phone Number. Use Cases: - Monitor partner business relationships and access permissions - Verify which businesses have access to shared pre-verified phone numbers - Retrieve partner business information for operational purposes - Validate partnership configurations before business operations Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with e | Version (string) Pre-Verified-Phone-Number-ID (string) User-Agent (string) Authorization (string) required fields (string) limit (integer) after (string) before (string) |
| post_by_version_by_pre_verified_phone_number_id_request_code | Request a verification code for a pre-verified phone number via SMS or voice call. This is part of the WhatsApp Business Account onboarding process where pre-approved phone numbers must be verified before they can be used for messaging. Process Flow: 1. Call this endpoint to request a verification code 2. User receives code via SMS or voice call 3. Use the verify_code endpoint to complete verification 4. Phone number becomes active for messaging Rate Limiting: - Limited number of code reques | Version (string) Pre-Verified-Phone-Number-ID (string) User-Agent (string) Authorization (string) required data: { . code_method (string) . language (string) } (object) required |
| post_by_version_by_pre_verified_phone_number_id_verify_code | Verify the OTP code received for a pre-verified phone number to complete the verification process. This endpoint validates the code and updates the verification status of the phone number. Use Cases: - Complete phone number verification during WhatsApp Business onboarding - Verify ownership of phone numbers for business messaging - Enable phone numbers for WhatsApp Business API usage Rate Limiting: This endpoint has specific rate limits to prevent abuse: - 125 requests per hour for business | Version (string) Pre-Verified-Phone-Number-ID (string) User-Agent (string) Authorization (string) required data: { . code (string) } (object) required |
| get_by_version_by_solution_id_access_token | Retrieve a granular BISU access token for accessing customer business resources through the Multi-Partner Solution. The token provides secure, scoped access to WhatsApp Business Accounts that have been shared with the solution. Use Cases: - Obtain secure access tokens for partner applications to access customer business resources - Enable multi-tenant partner architectures with dedicated tokens per customer business - Support secure API operations on shared WhatsApp Business Accounts - Impleme | Version (string) Solution-ID (string) User-Agent (string) Authorization (string) required business_id (string) required |
| post_by_version_by_solution_id_accept_deactivation_request | Accepts a pending deactivation request for a WhatsApp Business Multi-Partner Solution. This endpoint completes the partner approval workflow by accepting a deactivation request that was previously initiated by another solution partner. Upon successful acceptance, the solution status transitions from ACTIVE to DEACTIVATED, and the pending request status changes from PENDING_DEACTIVATION to NONE. Important Business Logic: - Solution must be in ACTIVE status with PENDING_DEACTIVATION pending s | Version (string) Solution-ID (string) User-Agent (string) Authorization (string) required fields (string) data (object) required |
| post_by_version_by_solution_id_accept | Accept an invitation to participate in a Multi-Partner Solution as a partner application. This endpoint transitions the partner's status from NOTIFICATION_SENT to ACCEPTED, enabling the solution to progress toward ACTIVE status once all required partners accept. Use Cases: - Accept partnership invitations for Multi-Partner Solutions - Activate partner participation in existing solutions - Confirm partner app's commitment to solution terms and conditions - Enable solution workflow progression f | Version (string) Solution-ID (string) User-Agent (string) Authorization (string) required data: { . partner_app_id (string) . log_session_id (string) } (object) required |
| get_by_version_by_solution_id | Retrieve comprehensive details about a Multi-Partner Solution, including its current status, pending status transitions, ownership information, and granted permissions. Use Cases: - Monitor solution lifecycle and status changes - Verify solution configuration before business onboarding - Check pending approval requests and status transitions - Retrieve solution ownership and permission details Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential b | Version (string) Solution-ID (string) User-Agent (string) Authorization (string) required fields (string) |
| post_by_version_by_solution_id_reject_deactivation_request | Reject a pending deactivation request for a Multi-Partner Solution. This endpoint allows solution partners to decline deactivation requests from solution owners, maintaining the solution in its current active operational state. Use Cases: - Reject deactivation requests from solution owners - Maintain active solution partnerships when deactivation is not appropriate - Respond programmatically to deactivation requests through API integration - Keep solutions operational when business requirement | Version (string) Solution-ID (string) User-Agent (string) Authorization (string) required fields (string) data: { . reject_deactivation_request (boolean) } (object) required |
| post_by_version_by_solution_id_reject | Reject a pending partnership request or deactivation request for a Multi-Partner Solution. This endpoint allows solution owners to decline incoming requests and maintain control over their solution partnerships and lifecycle. Use Cases: - Reject partnership requests from unauthorized or incompatible applications - Decline deactivation requests to keep solutions active - Maintain solution security and partnership quality - Control solution access and collaboration boundaries Request Types: - | Version (string) Solution-ID (string) User-Agent (string) Authorization (string) required data: { . request_type (string) . rejection_reason (string) . partner_app_id (string) } (object) required |
| post_by_version_by_solution_id_send_deactivation_request | Submit a deactivation request for a Multi-Partner Solution. This initiates a workflow to transition the solution from its current state to deactivated, following proper business validation and approval processes. Use Cases: - Request deactivation of an active Multi-Partner Solution - Initiate solution lifecycle transition management - Trigger business workflow for solution deactivation approval - Programmatically manage solution lifecycle states Business Logic: - Solution must be in ACTIVE o | Version (string) Solution-ID (string) User-Agent (string) Authorization (string) required data: { . reason (string) } (object) required |
| get_by_version_by_user_id_assigned_whatsapp_business_accounts | Retrieve WhatsApp Business Accounts that have been assigned to a specific user. This endpoint provides information about account assignments, permissions, and current status corresponding to the GraphAssignedWhatsAppBusinessAccountsEdge node. Use Cases: - Retrieve all WhatsApp Business Accounts assigned to a user - Check user permissions for specific accounts - Monitor account assignment status and changes - Validate user access before performing business operations Rate Limiting: Standard G | Version (string) User-ID (string) User-Agent (string) Authorization (string) required fields (string) limit (integer) after (string) before (string) |
| get_by_version_by_whats_app_account_number_id | Retrieve comprehensive details about a WhatsApp Account Number, including its current status, verification information, quality rating, and configuration settings. Use Cases: - Monitor account number status and quality rating - Verify account number configuration before messaging operations - Check verification and approval status - Retrieve display name and business profile information Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. | Version (string) WhatsApp-Account-Number-ID (string) User-Agent (string) Authorization (string) required fields (string) |
| get_by_version_by_whats_app_business_account_id_assigned_users | Retrieve a list of users assigned to the WhatsApp Business Account with their permissions and user details. This endpoint supports pagination and filtering capabilities. Use Cases: - Audit user access to WhatsApp Business Account - Retrieve user permission assignments for compliance - List all users with access for management purposes - Monitor user access patterns and assignments Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Cac | Version (string) WhatsApp-Business-Account-ID (string) User-Agent (string) Authorization (string) required business (string) required fields (string) limit (integer) after (string) before (string) |
| post_by_version_by_whats_app_business_account_id_assigned_users | Add a user to the WhatsApp Business Account with specified permission tasks. This operation grants the user access to perform specific actions on the account based on the provided permission tasks. Use Cases: - Grant user access to WhatsApp Business Account management - Assign specific permission tasks for granular access control - Add new team members to WhatsApp Business Account operations - Configure user permissions for different business roles Permission Tasks: Different permission task | Version (string) WhatsApp-Business-Account-ID (string) User-Agent (string) Authorization (string) required |
| delete_by_version_by_whats_app_business_account_id_assigned_users | Remove a user's access from the WhatsApp Business Account. This operation revokes all permissions and access rights for the specified user on the account. Use Cases: - Revoke user access when they leave the organization - Remove temporary access grants - Clean up user permissions for security compliance - Manage user lifecycle and access control Important Notes: - This operation removes ALL permissions for the user on this WhatsApp Business Account - The user will lose access to all account | Version (string) WhatsApp-Business-Account-ID (string) User-Agent (string) Authorization (string) required |
| post_by_version_by_phone_number_id_conversational_automation | Configure conversational automation settings for a WhatsApp Business Account phone number, including welcome messages, conversation prompts ice breakers, and bot commands. Use Cases: - Set up automated welcome messages for new customer conversations - Configure conversation prompts to guide customer interactions - Define bot commands for common customer service scenarios - Update existing automation settings - Enable or disable specific automation features Rate Limiting: Standard Graph API r | Version (string) Phone-Number-ID (string) User-Agent (string) Authorization (string) required data: { . enable_welcome_message (boolean) . prompts (array) . commands (array) } (object) required |
| get_by_version_by_business_id_extendedcredits | - Endpoint reference: Business Extendedcreditshttps://developers.facebook.com/docs/marketing-api/reference/extended-credit/ | Version (string) Business-ID (string) |
| get_by_version_by_waba_id_flows | List Flows | Version (string) WABA-ID (string) |
| post_by_version_by_waba_id_flows | Creates a new flow. To clone an existing flow you can add the parameter 'clone_flow_id': 'original-flow-id' | Version (string) WABA-ID (string) |
| post_by_version_by_waba_id_migrate_flows | Creates a copy of existing flows from source WABA to destination WABA with the same names. | Version (string) WABA-ID (string) |
| get_by_version_by_flow_id | Can request specific fields by enabling the fields query param | Version (string) Flow-ID (string) User-Agent (string) Authorization (string) required fields (string) date_format (string) |
| post_by_version_by_flow_id | Update Flow Metadata | Version (string) Flow-ID (string) |
| delete_by_version_by_flow_id | Deletes the flow entirely. This action is not reversible. Only a DRAFT flow can be deleted. | Version (string) Flow-ID (string) |
| get_by_version_by_flow_id_assets | Returns all assets attached to the flow. Currently only FLOW_JSON asset is supported | Version (string) Flow-ID (string) |
| post_by_version_by_flow_id_assets | Used to upload a flow JSON file with the flow content. Refer to flow JSON documentation here https://developers.facebook.com/docs/whatsapp/flows/reference/flowjsonhttps://developers.facebook.com/docs/whatsapp/flows/reference/flowjson The file must be attached as from data. The response will include any validation errors in the JSON file | Version (string) Flow-ID (string) |
| post_by_version_by_flow_id_publish | Updates the status of the flow as 'PUBLISHED'. This action is not reversible. The flow and its assets become immutable once published. To update the flow, you must create a new flow and specify the previous flow id as the clone_flow_id parameter | Version (string) Flow-ID (string) |
| post_by_version_by_flow_id_deprecate | Updates the status of the flow as 'DEPRECATED'. This action is not reversible. Only a published flow can be deprecated to prevent sending or opening it. | Version (string) Flow-ID (string) |
| get_by_version_by_waba_id_in_progress_onbehalf_request | Retrieve a list of in-progress on-behalf requests for the specified WhatsApp Business Account. These requests represent pending business relationship requests that have been sent from this WhatsApp Business Account to other businesses and are awaiting approval. Use Cases: - Monitor pending on-behalf requests sent from your WhatsApp Business Account - Track business partnership request status and workflow - Retrieve details about requesting and receiving businesses for pending requests - Manage | Version (string) WABA-ID (string) User-Agent (string) Authorization (string) required fields (string) limit (integer) after (string) before (string) |
| get_by_version_by_obo_mobility_intent_id | Retrieve details for a specific OBO Mobility Intent Node. This endpoint provides comprehensive information about the mobility intent, including current status, associated WABA and solution details, and operation history. Use Cases: - Monitor status of ongoing mobility operations - Retrieve mobility intent configuration details - Audit mobility operation progress - Verify operation parameters and settings Response Fields: The response includes the complete OBO Mobility Intent Node with all av | Version (string) OBO-Mobility-Intent-ID (string) User-Agent (string) Authorization (string) required fields (string) |
| post_by_version_by_waba_id_obo_mobility_intent | Create a new On-Behalf-Of mobility intent for a WhatsApp Business Account. This endpoint allows authorized solution providers to initiate mobility operations on behalf of business accounts, facilitating transfers and handovers between different solution providers. Use Cases: - Initiate account mobility process between solution providers - Request handover of account management - Schedule mobility operations for future execution - Coordinate multi-partner solution transitions Rate Limiting: S | Version (string) WABA-ID (string) User-Agent (string) Authorization (string) required data: { . solution_id (string) . intent_type . target_solution_id (string) . mobility_reason (string) . scheduled_execution_time (string) . metadata (object) } (object) required |
| get_by_version_by_waba_id_phone_numbers | Retrieve all phone numbers associated with a WhatsApp Business Account, including their status, verification details, and configuration information. Use Cases: - List all phone numbers in a WhatsApp Business Account - Monitor phone number status and verification progress - Check phone number quality ratings and messaging limits - Retrieve phone number configuration details Filtering: You can filter results using the filtering parameter with JSON-encoded filter conditions. Supported filters inc | Version (string) WABA-ID (string) User-Agent (string) Authorization (string) required fields (string) filtering (string) sort (string) limit (integer) after (string) before (string) |
| post_by_version_by_waba_id_phone_numbers | Create a new phone number registration within a WhatsApp Business Account. This endpoint initiates the phone number onboarding process, including verification and business name approval. Use Cases: - Add new phone numbers to a WhatsApp Business Account - Migrate phone numbers from on-premises to Cloud API - Register pre-verified phone numbers for BSP scenarios - Initiate phone number verification and business name approval process Prerequisites: - WhatsApp Business Account must have available | Version (string) WABA-ID (string) User-Agent (string) Authorization (string) required data: { . phone_number (string) . verified_name (string) . cc (string) . migrate_phone_number (boolean) . preverified_id (string) } (object) required |
| get_by_version_by_waba_id_schedules | Retrieve all schedules associated with a WhatsApp Business Account, including their configuration, status, and execution details. Use Cases: - List all schedules in a WhatsApp Business Account - Monitor schedule status and performance - Check schedule configuration and timing details - Retrieve schedule execution history and metrics Filtering: You can filter results using the filtering parameter with JSON-encoded filter conditions. Supported filters include status, schedule_type, and is_active | Version (string) WABA-ID (string) User-Agent (string) Authorization (string) required fields (string) filtering (string) sort (string) limit (integer) after (string) before (string) |
| post_by_version_by_waba_id_schedules | Create a new schedule configuration within a WhatsApp Business Account. This endpoint allows businesses to set up automated scheduling for various operations such as business hours, automated responses, and maintenance windows. Use Cases: - Create business hours schedules for automated responses - Set up maintenance windows for system operations - Configure automated message campaigns with timing - Establish recurring schedule patterns for business operations Prerequisites: - WhatsApp Business | Version (string) WABA-ID (string) User-Agent (string) Authorization (string) required data: { . name (string) . schedule_type . description (string) . start_time (string) . end_time (string) . timezone (string) . days_of_week (array) . is_active (boolean) . recurrence_pattern } (object) required |
| post_by_version_by_waba_id_set_obo_mobility_intent | Set On-Behalf-Of OBO mobility intent for a Multi-Partner Solution associated with a WhatsApp Business Account. This endpoint enables solution providers to establish OBO relationships for managing client WhatsApp Business Accounts. Use Cases: - Enable solution provider management of client WABA operations - Establish OBO relationships for business messaging solutions - Configure cross-platform mobility for WhatsApp Business messaging - Set up solution provider access to client accounts - Manage | Version (string) WABA-ID (string) User-Agent (string) Authorization (string) required data: { . waba_id (string) . solution_id (string) . app_id (string) . actor_id (string) . client_mutation_id (string) } (object) required |
| post_by_version_by_waba_id_set_solution_migration_intent | Set migration intent for a Multi-Partner Solution associated with a WhatsApp Business Account. This endpoint allows solution partners to initiate, schedule, confirm, or cancel migration processes for their solutions. Use Cases: - Initiate migration process for solution transitions - Schedule migration for a specific time - Confirm pending migration requests - Cancel previously set migration intents Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponent | Version (string) WABA-ID (string) User-Agent (string) Authorization (string) required data: { . solution_id (string) . migration_intent . target_solution_id (string) . migration_reason (string) . scheduled_migration_time (string) } (object) required |
| get_by_version_by_waba_id_solutions | Retrieve a paginated list of Multi-Partner Solutions associated with the specified WhatsApp Business Account. This endpoint supports field selection and cursor-based pagination for efficient data retrieval. Use Cases: - Discover available Multi-Partner Solutions for business onboarding - Monitor solution status and availability across your WABA - Retrieve solution ownership and permission details - Filter solutions by specific fields or status requirements Rate Limiting: Standard Graph API r | Version (string) WABA-ID (string) User-Agent (string) Authorization (string) required fields (string) limit (integer) after (string) before (string) |
| get_by_version_by_waba_id_subscribed_apps | Retrieve a list of all applications currently subscribed to webhook events for the specified WhatsApp Business Account. Use Cases: - Monitor which apps are subscribed to WABA webhook events - Audit subscription configurations and permissions - Verify subscription status before making changes - Retrieve subscription details for troubleshooting Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Subscription data can be cached f | Version (string) WABA-ID (string) User-Agent (string) Authorization (string) required fields (string) |
| post_by_version_by_waba_id_subscribed_apps | Subscribe your application to webhook events for the specified WhatsApp Business Account. This enables your app to receive real-time notifications for events such as message deliveries, status updates, and other WABA activities. Use Cases: - Enable webhook notifications for your app - Configure custom callback URLs for webhook delivery - Set up webhook verification tokens for security - Override default app webhook settings for specific WABAs Rate Limiting: Standard Graph API rate limits app | Version (string) WABA-ID (string) User-Agent (string) Authorization (string) required data: { . override_callback_uri (string) . verify_token (string) } (object) required |
| delete_by_version_by_waba_id_subscribed_apps | Unsubscribe your application from webhook events for the specified WhatsApp Business Account. This will stop your app from receiving webhook notifications for this WABA. Use Cases: - Disable webhook notifications when no longer needed - Clean up subscriptions during app decommissioning - Temporarily disable webhooks for maintenance - Remove subscriptions for WABAs no longer managed by your app Rate Limiting: Standard Graph API rate limits apply. Unsubscription operations are typically proces | Version (string) WABA-ID (string) User-Agent (string) Authorization (string) required |
| get_by_version_by_template_id | - Guide: Message Templateshttps://developers.facebook.com/docs/business-messaging/whatsapp/templates/overview - Guide: How To Monitor Quality Signalshttps://developers.facebook.com/docs/whatsapp/guides/how-to-monitor-quality-signals - Endpoint reference: WhatsApp Message Templatehttps://developers.facebook.com/docs/graph-api/reference/whats-app-business-hsm/ | Version (string) TEMPLATE_ID (string) |
| post_by_version_by_template_id | - Guide: Message Templateshttps://developers.facebook.com/docs/business-messaging/whatsapp/templates/overview - Guide: How To Monitor Quality Signalshttps://developers.facebook.com/docs/whatsapp/guides/how-to-monitor-quality-signals - Endpoint reference: WhatsApp Message Templatehttps://developers.facebook.com/docs/graph-api/reference/whats-app-business-hsm/ | Version (string) TEMPLATE_ID (string) data: { . category (string) . components (array) . language (string) . name (string) } (object) required |
| get_by_version_by_waba_id_message_templates | - Guide: Message Templateshttps://developers.facebook.com/docs/business-messaging/whatsapp/templates/overview - Guide: How To Monitor Quality Signalshttps://developers.facebook.com/docs/whatsapp/guides/how-to-monitor-quality-signals - Endpoint reference: WhatsApp Business Account Message Templateshttps://developers.facebook.com/docs/graph-api/reference/whats-app-business-account/message_templates/ | Version (string) WABA-ID (string) User-Agent (string) Authorization (string) required name (string) |
| post_by_version_by_waba_id_message_templates | - Guide: Authentication Templates with OTP Buttonshttps://developers.facebook.com/docs/business-messaging/whatsapp/templates/authentication-templates/authentication-templates - Guide: Message Templateshttps://developers.facebook.com/docs/business-messaging/whatsapp/templates/overview - Guide: How To Monitor Quality Signalshttps://developers.facebook.com/docs/whatsapp/guides/how-to-monitor-quality-signals - Endpoint reference: WhatsApp Business Account Message Templateshttps://developers.faceboo | Version (string) WABA-ID (string) data: { . category (string) . components (array) . language (string) . name (string) } (object) required |
| delete_by_version_by_waba_id_message_templates | - Guide: Message Templateshttps://developers.facebook.com/docs/business-messaging/whatsapp/templates/overview - Guide: How To Monitor Quality Signalshttps://developers.facebook.com/docs/whatsapp/guides/how-to-monitor-quality-signals - Endpoint reference: WhatsApp Business Account Message Templateshttps://developers.facebook.com/docs/graph-api/reference/whats-app-business-account/message_templates/ | Version (string) WABA-ID (string) User-Agent (string) Authorization (string) required name (string) hsm_id (string) |
| get_by_version_by_waba_id_activities | Retrieve activity logs and audit trails for a WhatsApp Business Account. This endpoint returns a chronological list of activities performed on the account, including administrative actions, configuration changes, and operational events. Use Cases: - Monitor account configuration changes and administrative actions - Generate compliance and audit reports for regulatory requirements - Track user activities and permission modifications - Investigate security incidents and unauthorized access attemp | Version (string) WABA-ID (string) User-Agent (string) Authorization (string) required fields (string) limit (integer) after (string) before (string) since (string) until (string) activity_type (string) |
| get_by_version_by_waba_id | Retrieve comprehensive details about a WhatsApp Business Account, including its configuration, status, and settings. Use Cases: - Retrieve WhatsApp Business Account configuration and details - Monitor account status and verification state - Check account ownership and business information - Validate account state before messaging operations Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Account details can be cached for mode | Version (string) WABA-ID (string) User-Agent (string) Authorization (string) required fields (string) |
| post_by_version_by_waba_id | Update configuration and settings for a WhatsApp Business Account. Use Cases: - Update WhatsApp Business Account name and configuration - Modify account settings and preferences - Update business information and verification details Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. | Version (string) WABA-ID (string) User-Agent (string) Authorization (string) required data: { . name (string) . timezone_id (string) } (object) required |
| get_by_version_by_waba_bot_id | Retrieve comprehensive details about a WhatsApp Business Bot, including its prompts, commands, and welcome message configuration. Use Cases: - Retrieve bot configuration and automated response settings - Monitor available bot commands and their descriptions - Check welcome message enablement status - Validate bot state before implementing automation - Audit bot configuration for business compliance Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponent | Version (string) WABA-Bot-ID (string) User-Agent (string) Authorization (string) required fields (string) |
| get_by_version_by_whats_app_business_profile_id | Retrieve comprehensive details about a WhatsApp Business Profile, including business information, contact details, and profile configuration. Use Cases: - Retrieve business profile information and metadata - Verify profile configuration and contact details - Check profile status and business information - Validate profile state before business operations Rate Limiting: Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff. Caching: Profile details can b | Version (string) WhatsApp-Business-Profile-ID (string) User-Agent (string) Authorization (string) required fields (string) |
| post_by_version_by_whats_app_business_profile_id | Update the WhatsApp Business Profile information such as business description, email, address, and other profile details. This operation corresponds to the GraphWhatsAppBusinessProfilePost functionality. Use Cases: - Update business profile information and metadata - Modify contact details and business description - Change business vertical classification - Update website URLs and profile picture - Maintain current business profile information Profile Picture Upload: It is recommended to use | Version (string) WhatsApp-Business-Profile-ID (string) User-Agent (string) Authorization (string) required data: { . messaging_product (string) . about (string) . address (string) . description (string) . email (string) . profile_picture_handle (string) . websites (array) . vertical } (object) required |
| post_whatsapp_webhooks | Endpoint for receiving webhook payloads for diverse incoming WhatsApp message types. | data: { . object (string) . entry (array) } (object) required |
| custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body (undefined) _headers (object) |
Webhook Events
This connector emits 1 event back to your workflow. To receive one, create a hook whose path is <connection-name>/<event> — the connection name you configured plus the event from the table below.
| Event | Description |
|---|---|
| messages | Inbound WhatsApp messages and delivery/read status updates for sent messages. |