Skip to main content
PATCH
Update Widget

Authorizations

Authorization
string
header
required

Your API key. Send in the Authorization header as: Bearer

Headers

X-Idempotency-Key
string | null

Path Parameters

widget_id
string
required

Body

application/json
clerk_org_id
string | null
name
string | null
Required string length: 1 - 100
agent_id
string | null
presentation
enum<string> | null
Available options:
video,
simple
primary_color
string | null
font_family
string | null
dark_mode
boolean | null
position
string | null
button_text
string | null
Maximum string length: 200
display_name
string | null
Maximum string length: 200
agent_subtext
string | null
Maximum string length: 200
widget_size
string | null
placement_mode
string | null
embedded_justification
string | null
show_transcript
boolean | null
show_post_call_recap
boolean | null
speaking_animation
boolean | null
animation_color
string | null
allowed_domains
string[] | null
profile_picture_url
string | null
speaking_picture_url
string | null

Response

Successful Response

data
PublicWidgetResource · object
required
meta
ResponseMeta · object
required

Metadata included in every API response.