Dashboards

Update a dashboard

PATCH/dashboards/{id}
dashboards:writeupdate_dashboardIdempotent

Changes the fields you send and returns the dashboard. user_type: null makes it the default dashboard. definition is replaced as a whole. A move onto a type and user type another live dashboard holds is not refused. dry_run shows the result without saving it. Emits dashboard.updated with the changed fields, and only when something changed; no email. Sending the earlier values undoes it.

Path parameters

  • idstring (uuid)Required#

    The dashboard's id, a UUID.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Request body

application/json, required · DashboardUpdate

  • typestring#

    Which page the dashboard lays out: HOMEPAGE is the platform home page, INVESTOR_DASHBOARD is the investor's dashboard.

    One of: HOMEPAGE, INVESTOR_DASHBOARD
  • user_typestring | null#

    The kind of user the dashboard is for: User (investor), Internal User, Entrepreneur or Advisor. Null makes it the default dashboard.

    One of: User, Internal User, Entrepreneur, Advisor
  • definitionobject#

    The page layout, replaced as a whole. A JSON object of up to 256 KiB once encoded.

{
  "definition": {
    "content": [],
    "root": {
      "props": {
        "title": "Home"
      }
    }
  }
}

Responses

200

The updated dashboard.

Dashboard
{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "type": "HOMEPAGE",
    "user_type": "User",
    "definition": {},
    "created_at": "2026-06-12T10:00:00+00:00",
    "updated_at": "2026-06-12T10:00:00+00:00"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
409

The request conflicts with existing state (error.code = conflict), e.g. a compliance flow with the requested name already exists.

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X PATCH https://your-org-domain/kong/core/api/v2/dashboards/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "definition": {
    "content": [],
    "root": {
      "props": {
        "title": "Home"
      }
    }
  }
}'