TRtrainy
Dashboards

Update a dashboard

Updates a dashboard's name, config, and/or default flag. Only the creator or an org admin/owner may modify a dashboard. A provided config REPLACES the stored one.

post/api/dashboards/update

Request

  • Base URL
    https://pluto-api.trainy.ai
  • Auth
    HTTP bearer

Request body

viewIdstring required

Dashboard view ID

namestring

New dashboard name

configobject

Replacement dashboard config (full replace, not a merge)

isDefaultboolean

Make this the project's default dashboard (admins/owners only)

expectedUpdatedAtstring date-time

Optimistic-concurrency guard. When set, the update is rejected with 409 if the dashboard changed after this timestamp.

Example request

{
  "viewId": "12"
}

Response

Dashboard updated successfully

idstring required
namestring required
projectNamestring required
isDefaultboolean required
currentVersioninteger required
sectionCountnumber required
widgetCountnumber required
updatedAtstring required
urlstring required

Changes

No recorded changes to this operation across all 1 revision of this API.