BAbasedash
Dashboards

Update a dashboard

Updates dashboard metadata (name, description, icon, color, folder, width, and default date range settings). Requires admin access to the organization.

patch/api/public/organizations/{orgId}/dashboards/{id}

Request

  • Base URL
    https://charts.basedash.com
  • Auth
    HTTP bearer

Path parameters

orgIdstring required

Organization ID

idstring required

Dashboard ID

Request body

namestring

Name of the dashboard

descriptionstring nullable

Optional description of the dashboard

iconstring

Icon name for the dashboard

colorstring

Icon color key for the dashboard

dashboardFolderIdstring nullable

ID of the folder to place the dashboard in

defaultCustomDateRangeStartstring date-time nullable

Start of the custom date range (when defaultDateRange is CUSTOM)

defaultCustomDateRangeEndstring date-time nullable

End of the custom date range (when defaultDateRange is CUSTOM)

Response

Dashboard updated successfully

Changes

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