Embed Widgets
Update Widget
Update an embed widget’s name, status, linked key, appearance, behavior, security, or intent config.
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": {}
}
'import requests
url = "https://api.example.com/api/v1/iframes/{id}"
payload = {
"name": "<string>",
"status": "<string>",
"api_key_id": "<string>",
"appearance": {},
"behavior": {},
"security": {},
"intent": {}
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
status: '<string>',
api_key_id: '<string>',
appearance: {},
behavior: {},
security: {},
intent: {}
})
};
fetch('https://api.example.com/api/v1/iframes/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/iframes/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'status' => '<string>',
'api_key_id' => '<string>',
'appearance' => [
],
'behavior' => [
],
'security' => [
],
'intent' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/iframes/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"status\": \"<string>\",\n \"api_key_id\": \"<string>\",\n \"appearance\": {},\n \"behavior\": {},\n \"security\": {},\n \"intent\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.example.com/api/v1/iframes/{id}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"status\": \"<string>\",\n \"api_key_id\": \"<string>\",\n \"appearance\": {},\n \"behavior\": {},\n \"security\": {},\n \"intent\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/iframes/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"status\": \"<string>\",\n \"api_key_id\": \"<string>\",\n \"appearance\": {},\n \"behavior\": {},\n \"security\": {},\n \"intent\": {}\n}"
response = http.request(request)
puts response.read_body{
"iframe": {}
}Authentication
Requires a Bearer token (API key) or a dashboard session.Path Parameters
The widget config UUID.
Request
All fields are optional — include only what you want to change.Display name for the widget.
"active" or "disabled".Re-link the widget to a different API key.
Visual customization (
primaryColor, position, borderRadius, fontFamily, …).Behavioral settings (
welcomeMessage, placeholder, maxPromptLength, enableFileUpload, enableVoice, strictAbuse).Security settings: the bot-protection toggle and the domain allowlist (
allowedOrigins/allowedDomains).Human-escalation intent config (custom keyword triggers and actions).
Response
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" }'
Was this page helpful?
⌘I
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": {}
}
'import requests
url = "https://api.example.com/api/v1/iframes/{id}"
payload = {
"name": "<string>",
"status": "<string>",
"api_key_id": "<string>",
"appearance": {},
"behavior": {},
"security": {},
"intent": {}
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
status: '<string>',
api_key_id: '<string>',
appearance: {},
behavior: {},
security: {},
intent: {}
})
};
fetch('https://api.example.com/api/v1/iframes/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/iframes/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'status' => '<string>',
'api_key_id' => '<string>',
'appearance' => [
],
'behavior' => [
],
'security' => [
],
'intent' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v1/iframes/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"status\": \"<string>\",\n \"api_key_id\": \"<string>\",\n \"appearance\": {},\n \"behavior\": {},\n \"security\": {},\n \"intent\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.example.com/api/v1/iframes/{id}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"status\": \"<string>\",\n \"api_key_id\": \"<string>\",\n \"appearance\": {},\n \"behavior\": {},\n \"security\": {},\n \"intent\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/iframes/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"status\": \"<string>\",\n \"api_key_id\": \"<string>\",\n \"appearance\": {},\n \"behavior\": {},\n \"security\": {},\n \"intent\": {}\n}"
response = http.request(request)
puts response.read_body{
"iframe": {}
}