Update a dashboard

PATCH/api/v1/dashboards/{dashboard_id}

Patch title, description, or visibility.

Operation ID: update_dashboard_api_v1_dashboards__dashboard_id__patch·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

dashboard_idstringrequired

Request body

Schema: UpdateDashboardRequest

titlestring
descriptionstring
visibilitystring

Responses

200Successful Response

Schema: SuccessEnvelope_DashboardResponse_

successboolean
messagestring
codestring
dataDashboardResponse

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

PATCH/api/v1/dashboards/{dashboard_id}

bash

curl -X PATCH 'https://api.ondayzero.com/api/v1/dashboards/{dashboard_id}' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "title": "string",
  "description": "string",
  "visibility": "string"
}'