dashboards

Update the markdown body, layout, or color of an existing text tile on a dashboard.

post/api/projects/{project_id}/dashboards/{id}/update_text_tile/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/dashboards/{id}/update_text_tile/
  • 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

tile_idinteger required

ID of the dashboard tile to update. Use dashboard-get to look up tile IDs.

bodystring

New markdown body for the text tile. Omit to leave the body unchanged. Max 4000 characters.

agent_contextstring nullable

Optional context that helps AI agents make consistent dashboard updates, such as Data Catalog metric names, data sources, tile-specific query assumptions, caveats, or editing guidance. PostHog's Data Catalog is the semantic layer. Store canonical metric definitions there, not in this field. An empty string or null means there is no agent context. Shared and exported dashboards, and organizations without AI data processing approval, omit this field. Max 10000 characters.

colorstring nullable

New accent color name, empty string or null to clear. Omit to leave unchanged.

Response

idinteger
layoutsunknown
colorstring nullable
filters_overridesunknown
show_descriptionboolean nullable
transparent_backgroundboolean nullable
group_keystring nullable

Changes

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