TypeScript SDK
import { Configuration, CanvasesApi } from '@widgetic/api-sdk-ts';
const config = new Configuration({
apiKey: 'YOUR_API_KEY'
});
const canvasesApi = new CanvasesApi(config);
try {
const canvas = await canvasesApi.updateCanvas({
id: "123e4567-e89b-12d3-a456-426614174000",
updateCanvasRequest: {
persistenceKey: "updated_canvas_xyz123",
canvasContent: { version: 2, elements: [{"id": "elem1"}], settings: {"theme": "dark"} }
}
});
console.log('Updated canvas:', canvas);
} catch (error) {
console.error('Failed to update canvas:', error);
}curl --request PUT \
--url https://api.widgetic.com/v1/canvases/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"persistenceKey": "updated_canvas_xyz123",
"canvasContent": {
"version": 2,
"elements": [
{
"id": "elem1"
}
],
"settings": {
"theme": "dark"
}
},
"primaryWidgetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
'import requests
url = "https://api.widgetic.com/v1/canvases/{id}"
payload = {
"persistenceKey": "updated_canvas_xyz123",
"canvasContent": {
"version": 2,
"elements": [{ "id": "elem1" }],
"settings": { "theme": "dark" }
},
"primaryWidgetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
persistenceKey: 'updated_canvas_xyz123',
canvasContent: {version: 2, elements: [{id: 'elem1'}], settings: {theme: 'dark'}},
primaryWidgetId: '3fa85f64-5717-4562-b3fc-2c963f66afa6'
})
};
fetch('https://api.widgetic.com/v1/canvases/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.widgetic.com/v1/canvases/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'persistenceKey' => 'updated_canvas_xyz123',
'canvasContent' => [
'version' => 2,
'elements' => [
[
'id' => 'elem1'
]
],
'settings' => [
'theme' => 'dark'
]
],
'primaryWidgetId' => '3fa85f64-5717-4562-b3fc-2c963f66afa6'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.widgetic.com/v1/canvases/{id}"
payload := strings.NewReader("{\n \"persistenceKey\": \"updated_canvas_xyz123\",\n \"canvasContent\": {\n \"version\": 2,\n \"elements\": [\n {\n \"id\": \"elem1\"\n }\n ],\n \"settings\": {\n \"theme\": \"dark\"\n }\n },\n \"primaryWidgetId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.widgetic.com/v1/canvases/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"persistenceKey\": \"updated_canvas_xyz123\",\n \"canvasContent\": {\n \"version\": 2,\n \"elements\": [\n {\n \"id\": \"elem1\"\n }\n ],\n \"settings\": {\n \"theme\": \"dark\"\n }\n },\n \"primaryWidgetId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.widgetic.com/v1/canvases/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"persistenceKey\": \"updated_canvas_xyz123\",\n \"canvasContent\": {\n \"version\": 2,\n \"elements\": [\n {\n \"id\": \"elem1\"\n }\n ],\n \"settings\": {\n \"theme\": \"dark\"\n }\n },\n \"primaryWidgetId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"persistenceKey": "canvas_xyz123",
"canvasContent": {
"version": 1,
"elements": [],
"settings": {}
},
"creatorId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"primaryWidgetId": "123e4567-e89b-12d3-a456-426614174099",
"managedUserId": "123e4567-e89b-12d3-a456-426614174077",
"createdAt": "2023-01-01T00:00:00Z",
"updatedAt": "2023-01-02T00:00:00Z"
},
"meta": {
"page": 1,
"size": 20,
"total": 135,
"limit": 20,
"offset": 0,
"hasNextPage": true,
"hasPreviousPage": false,
"nextCursor": "<string>",
"warnings": [
"<string>"
]
}
}{
"success": false,
"message": "<string>",
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "Composition not found",
"timestamp": "2026-10-15T10:00:00.000Z",
"param": "name",
"docUrl": "<string>",
"suggestedAction": "<string>",
"retryAfter": 60,
"details": {},
"correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
}
}{
"success": false,
"message": "<string>",
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "Composition not found",
"timestamp": "2026-10-15T10:00:00.000Z",
"param": "name",
"docUrl": "<string>",
"suggestedAction": "<string>",
"retryAfter": 60,
"details": {},
"correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
}
}Canvases
Update Canvas
Updates an existing canvas with the specified properties.
PUT
/
canvases
/
{id}
TypeScript SDK
import { Configuration, CanvasesApi } from '@widgetic/api-sdk-ts';
const config = new Configuration({
apiKey: 'YOUR_API_KEY'
});
const canvasesApi = new CanvasesApi(config);
try {
const canvas = await canvasesApi.updateCanvas({
id: "123e4567-e89b-12d3-a456-426614174000",
updateCanvasRequest: {
persistenceKey: "updated_canvas_xyz123",
canvasContent: { version: 2, elements: [{"id": "elem1"}], settings: {"theme": "dark"} }
}
});
console.log('Updated canvas:', canvas);
} catch (error) {
console.error('Failed to update canvas:', error);
}curl --request PUT \
--url https://api.widgetic.com/v1/canvases/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"persistenceKey": "updated_canvas_xyz123",
"canvasContent": {
"version": 2,
"elements": [
{
"id": "elem1"
}
],
"settings": {
"theme": "dark"
}
},
"primaryWidgetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
'import requests
url = "https://api.widgetic.com/v1/canvases/{id}"
payload = {
"persistenceKey": "updated_canvas_xyz123",
"canvasContent": {
"version": 2,
"elements": [{ "id": "elem1" }],
"settings": { "theme": "dark" }
},
"primaryWidgetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
persistenceKey: 'updated_canvas_xyz123',
canvasContent: {version: 2, elements: [{id: 'elem1'}], settings: {theme: 'dark'}},
primaryWidgetId: '3fa85f64-5717-4562-b3fc-2c963f66afa6'
})
};
fetch('https://api.widgetic.com/v1/canvases/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.widgetic.com/v1/canvases/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'persistenceKey' => 'updated_canvas_xyz123',
'canvasContent' => [
'version' => 2,
'elements' => [
[
'id' => 'elem1'
]
],
'settings' => [
'theme' => 'dark'
]
],
'primaryWidgetId' => '3fa85f64-5717-4562-b3fc-2c963f66afa6'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.widgetic.com/v1/canvases/{id}"
payload := strings.NewReader("{\n \"persistenceKey\": \"updated_canvas_xyz123\",\n \"canvasContent\": {\n \"version\": 2,\n \"elements\": [\n {\n \"id\": \"elem1\"\n }\n ],\n \"settings\": {\n \"theme\": \"dark\"\n }\n },\n \"primaryWidgetId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.widgetic.com/v1/canvases/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"persistenceKey\": \"updated_canvas_xyz123\",\n \"canvasContent\": {\n \"version\": 2,\n \"elements\": [\n {\n \"id\": \"elem1\"\n }\n ],\n \"settings\": {\n \"theme\": \"dark\"\n }\n },\n \"primaryWidgetId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.widgetic.com/v1/canvases/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"persistenceKey\": \"updated_canvas_xyz123\",\n \"canvasContent\": {\n \"version\": 2,\n \"elements\": [\n {\n \"id\": \"elem1\"\n }\n ],\n \"settings\": {\n \"theme\": \"dark\"\n }\n },\n \"primaryWidgetId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"persistenceKey": "canvas_xyz123",
"canvasContent": {
"version": 1,
"elements": [],
"settings": {}
},
"creatorId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"primaryWidgetId": "123e4567-e89b-12d3-a456-426614174099",
"managedUserId": "123e4567-e89b-12d3-a456-426614174077",
"createdAt": "2023-01-01T00:00:00Z",
"updatedAt": "2023-01-02T00:00:00Z"
},
"meta": {
"page": 1,
"size": 20,
"total": 135,
"limit": 20,
"offset": 0,
"hasNextPage": true,
"hasPreviousPage": false,
"nextCursor": "<string>",
"warnings": [
"<string>"
]
}
}{
"success": false,
"message": "<string>",
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "Composition not found",
"timestamp": "2026-10-15T10:00:00.000Z",
"param": "name",
"docUrl": "<string>",
"suggestedAction": "<string>",
"retryAfter": 60,
"details": {},
"correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
}
}{
"success": false,
"message": "<string>",
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "Composition not found",
"timestamp": "2026-10-15T10:00:00.000Z",
"param": "name",
"docUrl": "<string>",
"suggestedAction": "<string>",
"retryAfter": 60,
"details": {},
"correlationId": "req_123e4567-e89b-12d3-a456-426614174000"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ID of the canvas to update
Body
application/json
Updated key used for persistent storage and reference
Example:
"updated_canvas_xyz123"
Updated JSON content of the canvas
Example:
{
"version": 2,
"elements": [{ "id": "elem1" }],
"settings": { "theme": "dark" }
}
Primary widget for list/deep-link; omit to leave unchanged
Response
Canvas updated successfully
Always true on a success.
Example:
true
Show child attributes
Show child attributes
Example:
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"persistenceKey": "canvas_xyz123",
"canvasContent": {
"version": 1,
"elements": [],
"settings": {}
},
"creatorId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"primaryWidgetId": "123e4567-e89b-12d3-a456-426614174099",
"managedUserId": "123e4567-e89b-12d3-a456-426614174077",
"createdAt": "2023-01-01T00:00:00Z",
"updatedAt": "2023-01-02T00:00:00Z"
}
Extra information about the answer: where a page sits in a list, the cursor of the next page, or warnings about a call that succeeded with a caveat.
Show child attributes
Show child attributes