Skip to main content
PATCH
Update Widget

Headers

string
required
Your API key for authentication.

Path Parameters

string
required
UUID of the widget to update.

Body

string
New pathway UUID to associate with the widget. Must be defined if agent_prompt is null.
string
New pathway UUID to associate with the widget. Must be defined if pathway_id is null.
string[]
New array of allowed domains where the widget can be embedded.
number
New rate limit for messages (minimum: 0).
any
New widget configuration object (flexible JSON). Supports timeoutSeconds to configure conversation timeout (default: 86400 seconds / 24 hours).
string
New agent UUID to associate with the widget.
string
New URL to receive post-conversation webhook payloads when conversations end. See Post-Conversation Webhooks for payload details.

Response

number
HTTP status code (200 for success).
object
The updated widget object containing:
  • id (string): Widget UUID
  • pathway_id (string): Associated pathway UUID
  • agent_id (string | null): Associated agent UUID or null
  • allowed_domains (string[]): Array of allowed domains
  • messages_per_minute (number): Rate limit for messages
  • config (object): Widget configuration object
  • webhook_url (string | null): Post-conversation webhook URL or null
  • created_at (string): ISO timestamp
  • updated_at (string): Updated ISO timestamp
null
Always null on successful response.

Docs for agents: llms.txt