Skip to main content
PATCH
Update an agent's widget settings

Authorizations

Authorization
string
header
required

Your secret key (pep_sk_…) from Settings → API. Keys are org-scoped; treat them like passwords.

Path Parameters

slug
string
required

Body

application/json
disclaimer_text
string

Deprecated alias of disclaimer_text (renamed 2026-07-25).

offline_message
string
offline_cta
object
locale_default
string
allowed_domains
string[]
theme
object
reply_pace
enum<string>

How fast agent replies are typed out in the widget: conversational (reading pace, default), balanced, instant. Visitors can override it from the gauge in the chat header.

Available options:
conversational,
balanced,
instant
languages
string[]

Languages offered in the widget's language menu (2-letter codes). The agent's default is always listed first; the agent still answers in whatever language a visitor writes.

hosted_page
object
translations
object
chrome
object

Widget interface texts keyed by locale ({en: {placeholder: …}, fr: {…}}); merges per key, blank clears to the built-in wording.

daily_credit_budget

Per-agent daily budget in credits (visitor-facing spend cap).

Response

The updated settings.

object
string
required
Allowed value: "widget_setting"
agent
string
required

The agent's slug.

locale_default
string
required
disclaimer_text
string | null

Deprecated alias of disclaimer_text.

offline_message
string | null
offline_cta
object
allowed_domains
string[]
theme
object
reply_pace
enum<string>

How fast agent replies are typed out in the widget: conversational (reading pace, default), balanced, instant.

Available options:
conversational,
balanced,
instant
languages
string[]

Languages offered in the widget's language menu (2-letter codes). The agent's default is always listed first; the agent still answers in whatever language a visitor writes.

hosted_page
object
translations
object
chrome
object
daily_credit_budget

Per-agent daily budget in credits (visitor-facing spend cap).