Skip to main content

Overview

Update an existing WhatsApp Business integration. This endpoint allows you to modify the configuration of a connected WhatsApp number, such as its display name, access token, or other integration settings without recreating the integration.

Prerequisites

  • Bearer Token authentication
  • Valid WhatsApp Phone Number ID

Request

string
required
Bearer token for authenticated workspace access.
string
required
Unique identifier of the WhatsApp Business phone number.

Request Body

string
Updated display name for the WhatsApp Business account.
string
Updated Meta access token used for the integration.
string
Updated WhatsApp Business Account ID.

Response

boolean
Indicates whether the request completed successfully.
integer
HTTP status code returned by the API.
string
Confirmation message indicating the integration was updated successfully.
object
Updated WhatsApp integration details.
string
Unique identifier of the integration.
string
WhatsApp Business Phone Number ID.
string
Connected WhatsApp Business phone number.
string
Updated display name.
string
Current status of the integration.
string
Timestamp indicating when the integration was last updated.

Error Handling

Only the fields included in the request body are updated. Fields that are omitted remain unchanged.
After updating the integration, you can:
  • Retrieve all connected WhatsApp numbers using GET /api/whatsapp/whatsapp-number.
  • Assign or update a WhatsApp Agent for the integration.
  • Synchronize templates if your Meta configuration has changed.