Conversational Automation

Configure 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 rate limits apply. Use appropriate retry logic with exponential backoff.

Validation:

  • Command names must be unique within the same phone number
  • Prompts and command descriptions must comply with WhatsApp Business policies
  • Maximum limits are enforced for prompts and commands
post/{Version}/{Phone-Number-ID}/conversational_automation

Request

  • Base URL
    https://graph.facebook.com
  • URL
    https://graph.facebook.com/{Version}/{Phone-Number-ID}/conversational_automation
  • Auth
    HTTP bearer

Path parameters

Versionstring required

Graph API version to use for this request. Determines the API behavior and available features.

Phone-Number-IDstring 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.

Headers

User-Agentstring
Example:Meta-Business-Messaging-OpenAPI/1.0.0;spec=2025-10-21

The user agent string identifying the client software making the request.

Authorizationstring required
Example:Bearer EAABwzLixnjYBOzYmNMJJGfHq9DgNh...

Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token.

Request body

enable_welcome_messageboolean

Whether to enable welcome messages for new conversations

promptsstring[]

List of conversation prompts (ice breakers) to help guide customer interactions

Example request

{
  "enable_welcome_message": true,
  "prompts": [
    "How can I help you today?",
    "What product are you interested in?",
    "Do you need support?"
  ],
  "commands": [
    {
      "command_name": "help",
      "command_description": "Get help with your order"
    },
    {
      "command_name": "status",
      "command_description": "Check your order status"
    }
  ]
}

Response

Successfully configured conversational automation settings

successboolean required

Indicates whether the automation configuration was successful

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 5 revisions of this API.