Skip to main content
PATCH
/
api
/
v1
/
iframes
/
{id}
Update Widget
curl --request PATCH \
  --url https://api.example.com/api/v1/iframes/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "status": "<string>",
  "api_key_id": "<string>",
  "appearance": {},
  "behavior": {},
  "security": {},
  "intent": {}
}
'
{
  "iframe": {}
}

​
Authentication

Requires a Bearer token (API key) or a dashboard session.

​
Path Parameters

​
id
string
required
The widget config UUID.

​
Request

All fields are optional — include only what you want to change.
​
name
string
Display name for the widget.
​
status
string
"active" or "disabled".
​
api_key_id
string
Re-link the widget to a different API key.
​
appearance
object
Visual customization (primaryColor, position, borderRadius, fontFamily, …).
​
behavior
object
Behavioral settings (welcomeMessage, placeholder, maxPromptLength, enableFileUpload, enableVoice, strictAbuse).
​
security
object
Security settings: the bot-protection toggle and the domain allowlist (allowedOrigins/allowedDomains).
​
intent
object
Human-escalation intent config (custom keyword triggers and actions).

​
Response

​
iframe
object
The updated widget config.

​
Example

curl
curl -X PATCH https://www.hitheo.ai/api/v1/iframes/CONFIG_ID \
  -H "Authorization: Bearer $THEO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "status": "disabled" }'