Overview
Remove the currently assigned WhatsApp AI Agent from a connected WhatsApp Business phone number. After removing the assignment, the number will no longer be handled by an AI Agent until another agent is assigned.Prerequisites
- Bearer Token authentication
- A connected WhatsApp Business phone number with an assigned AI Agent
Request
string
required
Bearer token for authenticated workspace access.
string
required
Unique identifier of the WhatsApp Business phone number.
Response
boolean
Indicates whether the request completed successfully.
integer
HTTP status code returned by the API.
string
Confirmation message indicating the agent was removed successfully.
object
Details of the updated WhatsApp number.
string
WhatsApp Business phone number from which the agent was removed.
boolean
Indicates whether an AI Agent is currently assigned to the phone number.
Error Handling
Removing an agent does not delete the WhatsApp Agent itself. It only unlinks the agent from the selected WhatsApp Business phone number.
Related endpoints:
POST /api/whatsapp/add-agent-in-whatsapp-number— Assign an AI Agent to a WhatsApp number.GET /api/whatsapp/whatsapp-number— List connected WhatsApp Business numbers.GET /api/whatsapp/get-whatsapp-agent— List available WhatsApp AI Agents.