Skip to main content
PATCH
Update a custom dashboard

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.

Body

application/json

Create requires name. PATCH accepts name, sort_order, show_default_sections, and/or hidden_default_sections.

name
string
Required string length: 1 - 120
sort_order
integer
Required range: 0 <= x <= 1000000
show_default_sections
boolean

Set false for a blank canvas or true to restore the built-in overview.

hidden_default_sections
enum<string>[]

Complete list of built-in cards to hide individually; send an empty array to restore all.

Maximum array length: 21
Available options:
filter_bar,
kpi_conversations,
kpi_completion_rate,
kpi_average_duration,
kpi_success_rate,
kpi_conversation_spend,
call_activity,
outcome_mix,
assistant_performance,
post_call_intelligence,
campaign_funnel,
module_assistants,
module_campaigns,
module_audience,
module_booking,
module_knowledge,
module_simulations,
module_live_monitoring,
module_tools,
module_phone_numbers,
recent_calls

Response

Updated dashboard.

data
object
required