Skip to main content
PATCH
Move or resize a chart on a canvas, or change whi…

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

PATCH /v2/api/projects/:projectId/workspaces/:workspaceId/canvases/:canvasId/items/:itemId 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

PATCH /v2/api/projects/:projectId/workspaces/:workspaceId/canvases/:canvasId/items/:itemId 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

PATCH /v2/api/projects/:projectId/workspaces/:workspaceId/canvases/:canvasId/items/:itemId 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

PATCH /v2/api/projects/:projectId/workspaces/:workspaceId/canvases/:canvasId/items/:itemId 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

x
integer
Required range: -9007199254740991 <= x <= 9007199254740991
y
integer
Required range: -9007199254740991 <= x <= 9007199254740991
w
integer
Required range: 1 <= x <= 9007199254740991
h
integer
Required range: 1 <= x <= 9007199254740991
favorite_id
string<uuid>

Show this favorite on the tile instead of its current one. Must be a favorite in this workspace that is not already on the canvas.

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

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

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