WhatsApp Business
Messaging and business management via Meta Business API
OAuth65 native toolsIcon needs-review
This catalogue entry describes the current repository definition. Availability, scopes, and production readiness should be confirmed during private-beta onboarding.
Native tools
GET
whatsapp_list_businesses
List Meta businesses available to the connected user
/me/businesses
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| fields | string | optional | Comma-separated fields to include |
| limit | integer | optional | Maximum number of records to return |
| after | string | optional | Pagination cursor for the next page |
GET
whatsapp_list_whatsapp_business_accounts
List WhatsApp Business Accounts owned by a Meta business
/{business_id}/owned_whatsapp_business_accounts
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| business_id | string | optional | Meta business ID |
| fields | string | optional | Comma-separated fields to include |
| limit | integer | optional | Maximum number of records to return |
| after | string | optional | Pagination cursor for the next page |
GET
whatsapp_get_owned_business_accounts
List WhatsApp Business Accounts owned by a Meta business
/{business_id}/owned_whatsapp_business_accounts
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| business_id | string | optional | Meta business ID |
| fields | string | optional | Comma-separated fields to include |
| limit | integer | optional | Maximum number of records to return |
| after | string | optional | Pagination cursor for the next page |
GET
whatsapp_get_client_business_accounts
List client WhatsApp Business Accounts for a Meta business
/{business_id}/client_whatsapp_business_accounts
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| business_id | string | optional | Meta business ID |
| fields | string | optional | Comma-separated fields to include |
| limit | integer | optional | Maximum number of records to return |
| after | string | optional | Pagination cursor for the next page |
GET
whatsapp_get_business_account_details
Get WhatsApp Business Account details
/{waba_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| waba_id | string | optional | WhatsApp Business Account ID |
| fields | string | optional | Comma-separated fields to include |
GET
whatsapp_get_phone_numbers
List phone numbers for a WhatsApp Business Account
/{waba_id}/phone_numbers
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| waba_id | string | optional | WhatsApp Business Account ID |
| fields | string | optional | Comma-separated fields to include |
| limit | integer | optional | Maximum number of records to return |
| after | string | optional | Pagination cursor for the next page |
GET
whatsapp_get_phone_number
Get details for a WhatsApp Business phone number
/{phone_number_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
| fields | string | optional | Comma-separated fields to include |
GET
whatsapp_get_business_profile
Get the business profile for a WhatsApp phone number
/{phone_number_id}/whatsapp_business_profile
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
| fields | string | optional | Comma-separated fields to include |
POST
whatsapp_update_business_profile
Update the business profile for a WhatsApp phone number
/{phone_number_id}/whatsapp_business_profile
8 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
| messaging_product | string | required | Must be whatsapp |
| about | string | optional | Business profile About text |
| address | string | optional | Business address |
| description | string | optional | Business description |
| string | optional | Business email address | |
| vertical | string | optional | Business vertical |
| websites | array | optional | Business website URLs |
GET
whatsapp_get_message_templates
List message templates for a WhatsApp Business Account
/{waba_id}/message_templates
5 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| waba_id | string | optional | WhatsApp Business Account ID |
| name | string | optional | Message template name or ID |
| fields | string | optional | Comma-separated fields to include |
| limit | integer | optional | Maximum number of records to return |
| after | string | optional | Pagination cursor for the next page |
POST
whatsapp_create_message_template
Create a WhatsApp message template
/{waba_id}/message_templates
5 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| waba_id | string | optional | WhatsApp Business Account ID |
| name | string | required | Template name |
| category | string | required | Template category |
| language | string | required | Template language code |
| components | array | required | Template components |
POST
whatsapp_upsert_message_template
Create or update a WhatsApp message template
/{waba_id}/message_templates
5 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| waba_id | string | optional | WhatsApp Business Account ID |
| name | string | required | Template name |
| category | string | required | Template category |
| language | string | required | Template language code |
| components | array | required | Template components |
DELETE
whatsapp_delete_message_template
Delete a WhatsApp message template
/{waba_id}/message_templates
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| waba_id | string | optional | WhatsApp Business Account ID |
| name | string | required | Message template name or ID |
GET
whatsapp_get_template_status
Get the status and details of a message template
/{waba_id}/message_templates
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| waba_id | string | optional | WhatsApp Business Account ID |
| name | string | required | Message template name or ID |
| language | string | optional | Template language code |
GET
whatsapp_get_template_library
List WhatsApp templates and their template-library metadata
/{waba_id}/message_templates
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| waba_id | string | optional | WhatsApp Business Account ID |
| fields | string | optional | Comma-separated fields to include |
| limit | integer | optional | Maximum number of records to return |
| after | string | optional | Pagination cursor for the next page |
POST
whatsapp_send_message
Send a WhatsApp message
/{phone_number_id}/messages
6 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
| messaging_product | string | optional | Must be whatsapp |
| to | string | required | Recipient phone number |
| type | string | required | Message type |
| text | object | optional | Text message content |
| template | object | optional | Template message content |
POST
whatsapp_send_template
Send a pre-approved WhatsApp template message
/{phone_number_id}/messages
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
| messaging_product | string | optional | Must be whatsapp |
| to | string | required | Recipient phone number |
| template | object | required | Template configuration |
POST
whatsapp_send_template_message
Send a pre-approved WhatsApp template message
/{phone_number_id}/messages
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
| messaging_product | string | optional | Must be whatsapp |
| to | string | required | Recipient phone number |
| template | object | required | Template configuration |
POST
whatsapp_send_media
Send a media message to a WhatsApp number
/{phone_number_id}/messages
5 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
| messaging_product | string | optional | Must be whatsapp |
| to | string | required | Recipient phone number |
| type | string | required | Media type |
| media | object | required | Media payload |
POST
whatsapp_send_media_by_id
Send previously uploaded WhatsApp media by media ID
/{phone_number_id}/messages
6 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
| messaging_product | string | optional | Must be whatsapp |
| to | string | required | Recipient phone number |
| type | string | required | Media type |
| media_id | string | required | WhatsApp media ID |
| caption | string | optional | Optional media caption |
POST
whatsapp_send_contacts
Send contact cards to a WhatsApp number
/{phone_number_id}/messages
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
| messaging_product | string | optional | Must be whatsapp |
| to | string | required | Recipient phone number |
| contacts | array | required | Contact cards |
POST
whatsapp_send_location
Send a location message to a WhatsApp number
/{phone_number_id}/messages
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
| messaging_product | string | optional | Must be whatsapp |
| to | string | required | Recipient phone number |
| location | object | required | Location payload |
POST
whatsapp_send_interactive_buttons
Send an interactive button message
/{phone_number_id}/messages
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
| messaging_product | string | optional | Must be whatsapp |
| to | string | required | Recipient phone number |
| interactive | object | required | Interactive button payload |
POST
whatsapp_send_interactive_list
Send an interactive list message
/{phone_number_id}/messages
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
| messaging_product | string | optional | Must be whatsapp |
| to | string | required | Recipient phone number |
| interactive | object | required | Interactive list payload |
POST
whatsapp_upload_media
Upload media for use in WhatsApp messages
/{phone_number_id}/media
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
| messaging_product | string | optional | Must be whatsapp |
| file | string | required | Media file or URL |
| type | string | required | Media type |
GET
whatsapp_get_media_info
Get metadata and a temporary download URL for media
/{media_id}
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| media_id | string | required | WhatsApp media ID |
DELETE
whatsapp_delete_media
Delete uploaded WhatsApp media
/{media_id}
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| media_id | string | required | WhatsApp media ID |
POST
whatsapp_create_flow
Create a WhatsApp Flow
/{waba_id}/flows
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| waba_id | string | optional | WhatsApp Business Account ID |
| name | string | required | Flow name |
| categories | array | optional | Flow categories |
GET
whatsapp_list_flows
List WhatsApp Flows for a Business Account
/{waba_id}/flows
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| waba_id | string | optional | WhatsApp Business Account ID |
| fields | string | optional | Comma-separated fields to include |
| limit | integer | optional | Maximum number of records to return |
| after | string | optional | Pagination cursor for the next page |
GET
whatsapp_get_flow_assets
Get assets for a WhatsApp Flow
/{flow_id}/assets
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| flow_id | string | required | WhatsApp Flow ID |
| fields | string | optional | Comma-separated fields to include |
| limit | integer | optional | Maximum number of records to return |
| after | string | optional | Pagination cursor for the next page |
POST
whatsapp_update_flow_json
Upload or update the JSON definition of a WhatsApp Flow
/{flow_id}/assets
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| flow_id | string | required | WhatsApp Flow ID |
| file | string | required | Flow JSON file or content |
| name | string | required | Uploaded asset name, normally flow.json |
| asset_type | string | required | Flow asset type, normally FLOW_JSON |
POST
whatsapp_publish_flow
Publish a WhatsApp Flow
/{flow_id}/publish
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| flow_id | string | required | WhatsApp Flow ID |
GET
whatsapp_get_subscribed_apps
List applications subscribed to a WhatsApp Business Account
/{waba_id}/subscribed_apps
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| waba_id | string | optional | WhatsApp Business Account ID |
POST
whatsapp_subscribe_app
Subscribe the application to WhatsApp Business Account webhooks
/{waba_id}/subscribed_apps
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| waba_id | string | optional | WhatsApp Business Account ID |
DELETE
whatsapp_unsubscribe_app
Unsubscribe the application from WhatsApp Business Account webhooks
/{waba_id}/subscribed_apps
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| waba_id | string | optional | WhatsApp Business Account ID |
POST
whatsapp_register_phone
Register a WhatsApp Business phone number
/{phone_number_id}/register
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
| messaging_product | string | optional | Must be whatsapp |
| pin | string | required | Two-step verification PIN |
POST
whatsapp_deregister_phone
Deregister a WhatsApp Business phone number
/{phone_number_id}/deregister
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
POST
whatsapp_verify_code
Verify a WhatsApp Business phone number OTP code
/{phone_number_id}/verify_code
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
| code | string | required | OTP verification code |
POST
whatsapp_set_two_step_verification
Set or update the WhatsApp phone number two-step PIN
/{phone_number_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
| pin | string | required | Six-digit PIN |
GET
whatsapp_list_qr_codes
List WhatsApp QR codes for a phone number
/{phone_number_id}/message_qrdls
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
| fields | string | optional | Comma-separated fields to include |
| limit | integer | optional | Maximum number of records to return |
| after | string | optional | Pagination cursor for the next page |
POST
whatsapp_create_qr_code
Create a WhatsApp QR code
/{phone_number_id}/message_qrdls
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
| prefilled_message | string | required | Prefilled message |
DELETE
whatsapp_delete_qr_code
Delete a WhatsApp QR code
/{phone_number_id}/message_qrdls
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
| code | string | required | QR code value |
GET
whatsapp_get_business_compliance_info
Get WhatsApp Business compliance information
/{phone_number_id}/business_compliance_info
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
GET
whatsapp_get_business_encryption
Get WhatsApp Business encryption information
/{phone_number_id}/whatsapp_business_encryption
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
POST
whatsapp_configure_conversational_automation
Configure WhatsApp conversational automation
/{phone_number_id}/conversational_automation
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
| enable_welcome_message | boolean | optional | Whether welcome messages are enabled |
| prompts | array | optional | Conversation prompts |
| commands | array | optional | Bot command definitions |
POST
whatsapp_block_users
Block users for a WhatsApp Business phone number
/{phone_number_id}/block_users
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
| messaging_product | string | optional | Must be whatsapp |
| block_users | array | required | WhatsApp users to block |
DELETE
whatsapp_remove_assigned_user
Remove an assigned user from a WhatsApp Business Account
/{waba_id}/assigned_users
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| waba_id | string | optional | WhatsApp Business Account ID |
| user_id | string | required | Assigned user ID |
POST
whatsapp_create_upload_session
Create a WhatsApp media upload session
/{app_id}/uploads
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| app_id | string | required | Meta app ID |
| file_length | integer | required | File length in bytes |
| file_type | string | required | MIME type |
POST
whatsapp_attach_credit_line
Attach a business credit line to a client WhatsApp Business Account
/{credit_line_id}/whatsapp_credit_sharing_and_attach
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| credit_line_id | string | required | Credit line ID |
| waba_id | string | required | WhatsApp Business Account ID |
| waba_currency | string | required | Client WABA currency, for example INR or USD |
POST
whatsapp_update_business_account
Update WhatsApp Business Account metadata
/{waba_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| waba_id | string | optional | WhatsApp Business Account ID |
| fields | object | required | Business Account fields |
POST
whatsapp_mark_message_read
Mark an incoming WhatsApp message as read
/{phone_number_id}/messages
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
| messaging_product | string | optional | Must be whatsapp |
| status | string | optional | Read status, normally read |
| message_id | string | required | Incoming WhatsApp message ID |
POST
whatsapp_send_reaction
Send an emoji reaction to a WhatsApp message
/{phone_number_id}/messages
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
| messaging_product | string | optional | Must be whatsapp |
| to | string | required | Recipient phone number |
| reaction | object | required | Reaction payload containing message_id and emoji |
POST
whatsapp_send_interactive_product
Send a single-product or catalog interactive message
/{phone_number_id}/messages
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
| messaging_product | string | optional | Must be whatsapp |
| to | string | required | Recipient phone number |
| interactive | object | required | Product or catalog interactive payload |
POST
whatsapp_send_flow_message
Send an interactive WhatsApp Flow message
/{phone_number_id}/messages
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
| messaging_product | string | optional | Must be whatsapp |
| to | string | required | Recipient phone number |
| interactive | object | required | Flow interactive payload |
GET
whatsapp_get_flow
Get metadata for a WhatsApp Flow
/{flow_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| flow_id | string | required | WhatsApp Flow ID |
| fields | string | optional | Comma-separated fields to include |
GET
whatsapp_get_flow_preview_url
Get a preview URL for a WhatsApp Flow
/{flow_id}
2 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| flow_id | string | required | WhatsApp Flow ID |
| fields | string | optional | Use preview.invalidate(false) to reuse the active preview URL |
POST
whatsapp_update_flow_metadata
Update editable metadata for a WhatsApp Flow
/{flow_id}
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| flow_id | string | required | WhatsApp Flow ID |
| name | string | optional | New Flow name |
| categories | array | optional | Flow categories |
| endpoint_uri | string | optional | Flow data endpoint URI |
GET
whatsapp_get_qr_code
Get one QR code for a WhatsApp phone number
/{phone_number_id}/message_qrdls
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
| code | string | required | QR code value |
| fields | string | optional | Comma-separated fields to include |
POST
whatsapp_update_qr_code
Update the prefilled message for a WhatsApp QR code
/{phone_number_id}/message_qrdls
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
| code | string | required | QR code value |
| prefilled_message | string | required | Updated prefilled message |
GET
whatsapp_list_assigned_users
List users assigned to a WhatsApp Business Account
/{waba_id}/assigned_users
5 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| waba_id | string | optional | WhatsApp Business Account ID |
| business_id | string | optional | Meta business ID |
| fields | string | optional | Comma-separated fields to include |
| limit | integer | optional | Maximum number of records to return |
| after | string | optional | Pagination cursor for the next page |
GET
whatsapp_get_schedules
List scheduled WhatsApp message jobs
/{waba_id}/schedules
4 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| waba_id | string | optional | WhatsApp Business Account ID |
| fields | string | optional | Comma-separated fields to include |
| limit | integer | optional | Maximum number of records to return |
| after | string | optional | Pagination cursor for the next page |
GET
whatsapp_get_settings
Get Cloud API settings for a WhatsApp phone number
/{phone_number_id}/settings
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
POST
whatsapp_update_settings
Update Cloud API settings for a WhatsApp phone number
/{phone_number_id}/settings
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
| calling | object | optional | WhatsApp calling feature settings |
| storage_configuration | object | optional | WhatsApp storage configuration |
GET
whatsapp_get_commerce_settings
Get WhatsApp commerce settings
/{phone_number_id}/whatsapp_commerce_settings
1 parameter
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
POST
whatsapp_update_commerce_settings
Update WhatsApp commerce settings
/{phone_number_id}/whatsapp_commerce_settings
3 parameters
| Param | Type | Required | Description |
|---|---|---|---|
| phone_number_id | string | optional | WhatsApp Business phone number ID |
| is_cart_enabled | boolean | optional | Whether carts are enabled |
| is_catalog_visible | boolean | optional | Whether the catalog is visible |