canvas
Set Node Pinned
Toggle the pinned state for a single node.
Pinned nodes are excluded from auto-layout on the frontend. If the node has no saved position, creates one at (0, 0) with the requested pin state.
Returns: Complete set of saved positions after update.
PUT
/
canvas
/
positions
/
{resource_id}
/
pinned
Set Node Pinned
curl --request PUT \
--url https://api.example.com/canvas/positions/{resource_id}/pinned \
--header 'Content-Type: application/json' \
--data '{
"pinned": true
}'import requests
url = "https://api.example.com/canvas/positions/{resource_id}/pinned"
payload = { "pinned": True }
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({pinned: true})
};
fetch('https://api.example.com/canvas/positions/{resource_id}/pinned', 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.example.com/canvas/positions/{resource_id}/pinned",
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([
'pinned' => true
]),
CURLOPT_HTTPHEADER => [
"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.example.com/canvas/positions/{resource_id}/pinned"
payload := strings.NewReader("{\n \"pinned\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
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.example.com/canvas/positions/{resource_id}/pinned")
.header("Content-Type", "application/json")
.body("{\n \"pinned\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/canvas/positions/{resource_id}/pinned")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"pinned\": true\n}"
response = http.request(request)
puts response.read_body{
"positions": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Path Parameters
Body
application/json
Request body for toggling a node's pinned state.
Attributes: pinned: Whether the node should be excluded from auto-layout.
Response
Successful Response
Response body for canvas position queries.
Attributes: positions: Map of resource ID to node position.
Show child attributes
Show child attributes
Previous
List ViewsList all saved canvas views for the authenticated user.
Returns:
Saved canvas views ordered by creation time (newest first).
Next
⌘I
Set Node Pinned
curl --request PUT \
--url https://api.example.com/canvas/positions/{resource_id}/pinned \
--header 'Content-Type: application/json' \
--data '{
"pinned": true
}'import requests
url = "https://api.example.com/canvas/positions/{resource_id}/pinned"
payload = { "pinned": True }
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({pinned: true})
};
fetch('https://api.example.com/canvas/positions/{resource_id}/pinned', 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.example.com/canvas/positions/{resource_id}/pinned",
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([
'pinned' => true
]),
CURLOPT_HTTPHEADER => [
"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.example.com/canvas/positions/{resource_id}/pinned"
payload := strings.NewReader("{\n \"pinned\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
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.example.com/canvas/positions/{resource_id}/pinned")
.header("Content-Type", "application/json")
.body("{\n \"pinned\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/canvas/positions/{resource_id}/pinned")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"pinned\": true\n}"
response = http.request(request)
puts response.read_body{
"positions": {}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}