Skip to main content

Overview

Update an existing WhatsApp AI Agent by modifying its configuration, prompts, AI model, knowledge bases, assigned WhatsApp number, or other settings. Only the fields you provide will be updated.

Prerequisites

  • Bearer Token authentication
  • Valid WhatsApp Agent ID

Request

string
required
Bearer token for authenticated workspace access.
string
required
Unique identifier of the WhatsApp AI Agent to update.

Request Body

string
Updated display name of the WhatsApp Agent.
string
Assign the agent to a different WhatsApp Business number.
string
Updated system prompt that controls the agent’s behavior.
string
Updated greeting message shown to users.
array[string]
Updated list of Knowledge Base IDs available to the agent.
string
Updated AI model used by the agent.
number
Updated response creativity value.

Response

boolean
Indicates whether the request completed successfully.
integer
HTTP status code returned by the API.
string
Confirmation message indicating the agent was updated successfully.
object
Updated WhatsApp Agent information.
string
Unique identifier of the WhatsApp Agent.
string
Updated name of the WhatsApp Agent.
string
Current status of the agent.
string
Timestamp when the agent was last updated.

Error Handling

Only the fields included in the request are updated. Any omitted fields retain their existing values.
After updating an agent, you can verify the changes using:
  • GET /api/whatsapp/get-whatsapp-agent
  • GET /api/whatsapp/get-whatsapp-agent/{agentId}