Update or revoke a widget key
curl --request PATCH \
--url https://api.kataven.ai/v1/api/v1/widget-keys/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"agent_id": "agent_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z",
"disabled": false,
"domain_allowlist": [
"https://acme.com",
"https://www.acme.com",
"https://app.acme.com"
],
"name": "acme.com production (renamed)"
}
'import requests
url = "https://api.kataven.ai/v1/api/v1/widget-keys/{id}"
payload = {
"agent_id": "agent_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z",
"disabled": False,
"domain_allowlist": ["https://acme.com", "https://www.acme.com", "https://app.acme.com"],
"name": "acme.com production (renamed)"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agent_id: 'agent_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z',
disabled: false,
domain_allowlist: ['https://acme.com', 'https://www.acme.com', 'https://app.acme.com'],
name: 'acme.com production (renamed)'
})
};
fetch('https://api.kataven.ai/v1/api/v1/widget-keys/{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.kataven.ai/v1/api/v1/widget-keys/{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([
'agent_id' => 'agent_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z',
'disabled' => false,
'domain_allowlist' => [
'https://acme.com',
'https://www.acme.com',
'https://app.acme.com'
],
'name' => 'acme.com production (renamed)'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.kataven.ai/v1/api/v1/widget-keys/{id}"
payload := strings.NewReader("{\n \"agent_id\": \"agent_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z\",\n \"disabled\": false,\n \"domain_allowlist\": [\n \"https://acme.com\",\n \"https://www.acme.com\",\n \"https://app.acme.com\"\n ],\n \"name\": \"acme.com production (renamed)\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.kataven.ai/v1/api/v1/widget-keys/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agent_id\": \"agent_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z\",\n \"disabled\": false,\n \"domain_allowlist\": [\n \"https://acme.com\",\n \"https://www.acme.com\",\n \"https://app.acme.com\"\n ],\n \"name\": \"acme.com production (renamed)\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kataven.ai/v1/api/v1/widget-keys/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agent_id\": \"agent_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z\",\n \"disabled\": false,\n \"domain_allowlist\": [\n \"https://acme.com\",\n \"https://www.acme.com\",\n \"https://app.acme.com\"\n ],\n \"name\": \"acme.com production (renamed)\"\n}"
response = http.request(request)
puts response.read_body"<string>""<string>""<string>"Widget Keys
Update or revoke a widget key
Renames the key, replaces the domain allowlist, repins the agent, or revokes (disabled=true sets disabled_at=now() — idempotent).
PATCH
/
api
/
v1
/
widget-keys
/
{id}
Update or revoke a widget key
curl --request PATCH \
--url https://api.kataven.ai/v1/api/v1/widget-keys/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"agent_id": "agent_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z",
"disabled": false,
"domain_allowlist": [
"https://acme.com",
"https://www.acme.com",
"https://app.acme.com"
],
"name": "acme.com production (renamed)"
}
'import requests
url = "https://api.kataven.ai/v1/api/v1/widget-keys/{id}"
payload = {
"agent_id": "agent_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z",
"disabled": False,
"domain_allowlist": ["https://acme.com", "https://www.acme.com", "https://app.acme.com"],
"name": "acme.com production (renamed)"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agent_id: 'agent_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z',
disabled: false,
domain_allowlist: ['https://acme.com', 'https://www.acme.com', 'https://app.acme.com'],
name: 'acme.com production (renamed)'
})
};
fetch('https://api.kataven.ai/v1/api/v1/widget-keys/{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.kataven.ai/v1/api/v1/widget-keys/{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([
'agent_id' => 'agent_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z',
'disabled' => false,
'domain_allowlist' => [
'https://acme.com',
'https://www.acme.com',
'https://app.acme.com'
],
'name' => 'acme.com production (renamed)'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.kataven.ai/v1/api/v1/widget-keys/{id}"
payload := strings.NewReader("{\n \"agent_id\": \"agent_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z\",\n \"disabled\": false,\n \"domain_allowlist\": [\n \"https://acme.com\",\n \"https://www.acme.com\",\n \"https://app.acme.com\"\n ],\n \"name\": \"acme.com production (renamed)\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.kataven.ai/v1/api/v1/widget-keys/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agent_id\": \"agent_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z\",\n \"disabled\": false,\n \"domain_allowlist\": [\n \"https://acme.com\",\n \"https://www.acme.com\",\n \"https://app.acme.com\"\n ],\n \"name\": \"acme.com production (renamed)\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kataven.ai/v1/api/v1/widget-keys/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agent_id\": \"agent_01HZ2N7G3K8M0Q5R7T9V2X4Y6Z\",\n \"disabled\": false,\n \"domain_allowlist\": [\n \"https://acme.com\",\n \"https://www.acme.com\",\n \"https://app.acme.com\"\n ],\n \"name\": \"acme.com production (renamed)\"\n}"
response = http.request(request)
puts response.read_body"<string>""<string>""<string>"Authorizations
Headers
Tenant database. Required when using a Zitadel JWT.
Path Parameters
Widget key id (uuid)
Body
application/json
Fields to update
Response
Updated

