Skip to main content
PATCH
Update a dashboard widget

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access.

Path Parameters

id
string<uuid>
required

Dashboard ID.

widgetId
string<uuid>
required

Widget ID.

Body

application/json

POST: provide widget_id to attach an existing reusable widget, or name to create one. PATCH: only provided fields change.

widget_id
string<uuid>
name
string
Required string length: 1 - 120
widget_type
enum<string>
Available options:
statistic,
chart,
table
data_table
enum<string>
Available options:
calls,
campaigns,
assistants,
phone_numbers,
conversions,
leads,
knowledge_bases,
bookings,
tools,
simulations
aggregation
enum<string>
Available options:
count,
sum,
avg,
max,
min
column_name
string | null
compare_previous_period
boolean
rate_range
enum<string>
Available options:
7d,
14d,
30d,
90d
table_columns
string[]
Maximum array length: 30
assistant_id
string | null
visualization
enum<string>
Available options:
auto,
number,
line,
area,
bar,
stacked_bar,
donut,
pie,
funnel,
heatmap,
table,
leaderboard
group_by
string | null
campaign_id
string<uuid> | null
show_legend
boolean
show_values
boolean
description
string | null
conditions
object[]
Maximum array length: 20
sort_order
integer
Required range: x >= 0
grid_w
integer
Required range: 3 <= x <= 12
grid_h
integer
Required range: 1 <= x <= 4

Response

Updated widget.

data
object
required