Skip to main content
POST
Add a chart to a canvas from a saved favorite. It…

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

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

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

POST /v2/api/projects/:projectId/workspaces/:workspaceId/canvases/:canvasId/items Request body

favorite_id
string<uuid>
required
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})$
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
default:1
Required range: 1 <= x <= 9007199254740991
h
integer
default:1
Required range: 1 <= x <= 9007199254740991
tabId
string

The tab of the canvas's page the tile goes in: the id of its . Without it, or on a page without that tab, the tile goes in the page's first grid.

Pattern: ^[A-Za-z0-9_-]{1,64}$

Response

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

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