provider dashboards PATCH /api/environments/{environment_id}/dashboards/{id}/widgets/batch_update/
@utdk/posthog /api/environments/{environment_id}/dashboards/{id}/widgets/batch_update/
environments_dashboards_update_widgets_batch
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.
environment_id path required
Deprecated. Use /api/projects/{project_id}/ instead.
string
format query
enum: json, txt
id path required
A unique integer value identifying this dashboard.
integer

Try it

Authentication
Configure credentials for PostHog API
environmentsDashboardsUpdateWidgetsBatch
PATCH/api/environments/{environment_id}/dashboards/{id}/widgets/batch_update/
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.

Parameters

required

Deprecated. Use /api/projects/{project_id}/ instead.

required

A unique integer value identifying this dashboard.

Input

Widget tiles to update atomically, each identified by its tile_id. config shape is per widget_type; see dashboard-widget-catalog-list for per-type config_schema (1–10 per request).

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import posthog from '@utdk/posthog';

await posthog.environmentsDashboardsUpdateWidgetsBatch()