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
offline_message
string
offline_cta
object
locale_default
string
allowed_domains
string[]
theme
object
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
offline_message
string | null
offline_cta
object
allowed_domains
string[]
theme
object
hosted_page
object
translations
object
chrome
object
daily_credit_budget

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