Skip to main content
PATCH
/
api
/
public
/
organizations
/
{orgId}
/
dashboards
/
{dashboardId}
/
tabs
/
{tabId}
Update a dashboard tab
curl --request PATCH \
  --url https://charts.basedash.com/api/public/organizations/{orgId}/dashboards/{dashboardId}/tabs/{tabId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "order": 123
}
'
{
  "data": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "order": 123,
    "dashboardId": "<string>"
  }
}

Authorizations

Authorization
string
header
required

API key authentication using Bearer token format: Bearer <basedash_api_key>

Path Parameters

orgId
string
required

Organization ID

dashboardId
string
required

Dashboard ID

tabId
string
required

Dashboard tab ID

Body

application/json
name
string

Name of the tab

Minimum string length: 1
order
number

Sort order of the tab within the dashboard. Defaults to placing the tab last.

Response

Dashboard tab updated successfully

data
object
required