Agent17

Agent Config6

Agent Endpoint4

Analytics2

Autoimprove8

Benchmark6

Call11

Chat5

CLI Auth1

Config2

Customer Flow8

Customer Flow Edge Case4

Dashboard10

Health1

HTTP Request Definition4

Issue3

Knowledge Base3

Live Report8

Me4

Metric11

Metric Collection Job6

Metric Policy5

Organization Project5

Organization Project API Key3

Organization Project Member4

Phone Number6

Project1

Prospect Simulation3

Simulation17

Simulation Environment5

Simulation Job3

Simulation Persona5

Simulation Run Plan5

Simulation Run Plan Job7

Simulation Template1

Usage1

Webhook4

Webhooks

Metric1

Webhook1

Dashboard

Update a dashboard

Changed on Oct 21, 2026

Edits a dashboard. Omitted fields keep their current value. widgets, when sent, replaces the list: widgets are matched by name, so a widget that keeps its name keeps its id; a new name adds a widget and a name no longer listed removes it. To change one widget, PUT /v1/dashboard/{dashboardId}/widget/{widgetId}.

put/v1/dashboard/{dashboardId}

Request

Base URL
https://api.roark.ai
URL
https://api.roark.ai/v1/dashboard/{dashboardId}
Auth
HTTP bearer

Path parameters

dashboardIdstring uuid required

The dashboard ID

Request body

namestring

descriptionstring

isDefaultboolean

Example request

{
  "timeRange": {
    "type": "CALENDAR_ALIGNED",
    "period": "THIS_MONTH"
  }
}

Response

The updated dashboard

Changes

Oct 21, 20268913d3b08c7b Revision changes
- breaking
  the response property /// became optional for the status
- breaking
  the response property /////// became optional for the status
- breaking
  the response property ///// became optional for the status
- breaking
  the response property /////// became optional for the status
- warning
  added the new IS_NOT_SET enum value to the /// response property for the response status
- warning
  added the new IS_NOT_SET enum value to the /////// response property for the response status
- warning
  added the new IS_NOT_SET enum value to the ///// response property for the response status
- warning
  added the new IS_NOT_SET enum value to the /////// response property for the response status
- warning
  added the new IS_NOT_SET enum value to the ///// response property for the response status
- warning
  added the new IS_SET enum value to the /// response property for the response status
- warning
  added the new IS_SET enum value to the /////// response property for the response status
- warning
  added the new IS_SET enum value to the ///// response property for the response status
- warning
  added the new IS_SET enum value to the /////// response property for the response status
- warning
  added the new IS_SET enum value to the ///// response property for the response status
- info
  the request property // became optional
- info
  the request property ////// became optional
- info
  the request property //// became optional
- info
  the request property ////// became optional
- info
  added the new IS_NOT_SET enum value to the request property //
- info
  added the new IS_NOT_SET enum value to the request property //////
- info
  added the new IS_NOT_SET enum value to the request property ////
- info
  added the new IS_NOT_SET enum value to the request property //////
- info
  added the new IS_NOT_SET enum value to the request property ////
- info
  added the new IS_SET enum value to the request property //
- info
  added the new IS_SET enum value to the request property //////
- info
  added the new IS_SET enum value to the request property ////
- info
  added the new IS_SET enum value to the request property //////
- info
  added the new IS_SET enum value to the request property ////
Oct 21, 20262e403107d6ec Revision changes
- info
  endpoint added

Operation history