dashboards

Update the settings of existing widgets in place, atomically — config, name, and description.

Each entry targets a widget by its tile_id and reuses the same write path as the dashboard PATCH endpoint. The widget_type is immutable. This edits widget settings only (config, name, description); tile placement (layouts, show_description) is a dashboard concern — use the dashboard PATCH endpoint or reorder_tiles for that. All updates succeed or fail together. To add new widgets, use the widgets/batch POST endpoint; to remove one, use delete_tile.

patch/api/projects/{project_id}/dashboards/{id}/widgets/batch_update/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/dashboards/{id}/widgets/batch_update/
  • Auth: HTTP bearer

Path parameters

idinteger required

A unique integer value identifying this dashboard.

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

format'json' | 'txt'

Request body

Response

Changes

No recorded changes to this operation across all 1 revision of this API.