Sign in
dashboards

Favorite Dashboard

Mark this dashboard as a favourite for the current user (idempotent).

Per-user state, but VIEWER on the resource is still required: company membership alone would let any member toggle a favourite on a dashboard they cannot see and use the 403-vs-404 split to enumerate dashboard ids. The permission check runs BEFORE the load so both "missing" and "inaccessible" collapse to 403 for non-owners — matching PUT /apps/{id}/favorite, and the OPPOSITE order of get_dashboard (which loads first, then checks — see that function and domains/dashboards/CLAUDE.md for why this pair is the exception).

put/api/v1/dashboards/{dashboard_id}/favorite

Path parameters

dashboard_idstring uuid required

Response

Successful Response

idstring uuid required
company_idstring uuid required
project_idstring uuid nullable
is_favoriteboolean
user_idstring uuid required
namestring required
descriptionstring required
statusstring required
current_version_idstring uuid nullable
bundle_urlstring nullable required
bundle_cssstring nullable required
bundle_importsstring[] nullable required
error_messagestring nullable required
is_suppressedboolean required
created_atstring date-time required
updated_atstring date-time required

Changes

Changed in 1 of the 17 revisions of this API.1

Of the 17 revisions, 1 has no diff computed.