Skip to main content
PUT
Change the chart a tile shows: a new chart (store…

Authorizations

authorization
string
header
required

Path Parameters

projectId
string<uuid>
required

The project in the URL. The caller's project user is read from it.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
workspaceId
string<uuid>
required

PUT /v2/api/projects/:projectId/workspaces/:workspaceId/canvases/:canvasId/items/:itemId/chart Parameter

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
canvasId
string<uuid>
required

PUT /v2/api/projects/:projectId/workspaces/:workspaceId/canvases/:canvasId/items/:itemId/chart Parameter

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
itemId
string<uuid>
required

PUT /v2/api/projects/:projectId/workspaces/:workspaceId/canvases/:canvasId/items/:itemId/chart Parameter

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Body

application/json

PUT /v2/api/projects/:projectId/workspaces/:workspaceId/canvases/:canvasId/items/:itemId/chart Request body

apiKey
string

Upsolve API key, generated under Account → Developer settings in the Upsolve Hub. Keys are user-scoped: pass organizationId alongside the key to select which org to act on.

Minimum string length: 1
organizationId
string

The ID of the organization. Required when using Supabase JWT authentication.

connectionId
string

The ID of the connection a guest has access to

chart
object

The tile's new chart (query, shape, render). Stored as a new chart of this canvas; the tile's old one is kept for Undo.

baseChartId
string<uuid>

The chart id the tile showed when you read it (item.favorite_id). The change is refused (409) when the tile shows another one now.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
name
string

The new chart's name; unset keeps the tile's current one.

Required string length: 1 - 200
snapshot_data
object[] | null

The new chart's rows as last run, shown when the canvas is on Snapshot. At most 500 are kept.

chartId
string<uuid>

Instead of chart: point the tile back at one of this canvas's earlier charts (Undo / Redo of an edit).

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Response

PUT /v2/api/projects/:projectId/workspaces/:workspaceId/canvases/:canvasId/items/:itemId/chart Positive response

status
string
required
Allowed value: "success"
data
object
required