Skip to main content

Update dashboard

PUT /v2/dashboard/:id

Updates an existing dashboard identified by its unique ID. This endpoint allows modification of dashboard metadata such as name, role, status, and section configurations. It can also update nested section details, including type, mode, and associated data. Useful for managing user- or role-specific dashboards within a tenant environment.

Request Body​

{
    "_id": "685a9629c09c3762ec610179",
    "name": "test featured",
    "role": "admin",
    "roleDisplay": "Administrator",
    "tenant": "65f30de934f1cc0977ded014",
    "source": "Customer portal",
    "sourcePage": "Home",
    "status": "active",
    "sections": [
      {
       "type": "product",
        "_id": "685aa876408f19e641007672",
        "mode": "who cares"
      },
      {
        "type": "product",
        "_id": "685aa876408f19e641007672",
        "data": [
          {
            "id": "b52ad07c-47fd-4509-abce-432cace1d77d"
          }
        ],
        "mode": "featured",
        "sectionTitle": ""
      }
    ],
    "created": "2025-06-24T12:12:25.450Z",
    "updated": "2025-06-24T13:30:37.801Z"
  }

Response Example​

{
  "_id": "dashboard-id-1",
  "name": "Example Dashboard",
  "role": "admin",
  "roleDisplay": "Administrator",
  "tenant": "tenant-id-1",
  "status": "active",
  "sections": [
    {
      "type": "product",
      "_id": "section-id-1",
      "mode": "overview"
    },
    {
      "type": "product",
      "data": [
        {
          "id": "item-id-1"
        }
      ],
      "_id": "section-id-2",
      "mode": "featured",
      "sectionTitle": "Top Products"
    }
  ],
  "created": "2025-10-29T13:52:48.467Z",
  "updated": "2025-10-29T13:53:25.899Z",
  "source": "Customer Portal",
  "sourcePage": "Home"
}