Phone Numbers

Update WhatsApp Business Account Phone Number Status and Configuration

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 verification
  • Configure search visibility and privacy settings
  • Set username for the WhatsApp Business Account
  • Override webhook callback URIs for message notifications

Business Logic Requirements:

  • App must be linked to the WhatsApp Business Account
  • Webhook subscription must exist before configuring callback URI overrides
  • Callback URI verification is performed for external URLs
  • Internal URLs are allowed for development environments

Rate Limiting: WhatsApp use case throttling applies. Use appropriate retry logic with exponential backoff.

Security Validations:

  • App-to-WABA linking validation enforced
  • Webhook callback URI verification required for external URLs
  • Business integration system user checks for AI bot onboarding
  • Capability checks for first-party app access
post/{Version}/{Phone-Number-ID}

Request

  • Base URL
    https://graph.facebook.com
  • URL
    https://graph.facebook.com/{Version}/{Phone-Number-ID}
  • 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 Account phone number ID (CSID). This ID is provided when you register the phone number and can be found in your WhatsApp Business Manager.

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

connection_status'CONNECTED' | 'DISCONNECTED' | 'PENDING' | 'FLAGGED' | 'RESTRICTED' | 'RATE_LIMITED' | 'MESSAGING_LIMIT_TIER_0' | 'MESSAGING_LIMIT_TIER_1' | 'MESSAGING_LIMIT_TIER_2' | 'MESSAGING_LIMIT_TIER_3' | 'MESSAGING_LIMIT_TIER_4'

Connection status between WhatsApp Business Account and phone number

webhook_urlstring uri

Webhook URL for receiving message notifications

pinstring

Two-step verification PIN (can be empty string)

search_visibility'VISIBLE' | 'HIDDEN'

Search visibility status for the WhatsApp Business Account

new_display_namestring

New display name for name verification request

usernamestring

Username for the WhatsApp Business Account

Example request

{
  "connection_status": "CONNECTED",
  "webhook_url": "https://your-domain.com/webhook",
  "whatsapp_business_api_data": {
    "pin": "123456",
    "show_security_notifications": true
  },
  "pin": "123456",
  "search_visibility": "VISIBLE",
  "webhook_configuration": {
    "override_callback_uri": "https://your-domain.com/webhook/override",
    "verify_token": "YOUR_VERIFY_TOKEN"
  },
  "new_display_name": "My Business Name",
  "username": "mybusiness"
}

Response

Operation completed successfully

OR

Example response

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "+1234567890",
      "wa_id": "1234567890"
    }
  ],
  "messages": [
    {
      "id": "wamid.HBgLMTY3NzE4NDM4NjAVAgARGBI5QTRCMEM4RjA2NzY4RTlBNAA="
    }
  ]
}

Changes

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