Start free trial

Update a widget

PATCH/api/v1/dashboards/{dashboard_id}/widgets/{widget_id}

Patch a widget's title, layout, or (text widgets) body.

Operation ID: update_widget_api_v1_dashboards__dashboard_id__widgets__widget_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
widget_idstringrequired

Request body

Schema: UpdateWidgetRequest

titlestring
layoutWidgetLayout
bodystring

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