Update canvas metadata

Partial update of a canvas's metadata — only the fields you pass change. Accepts name, description, and is_active. The canvas must belong to the resolved location. Requires an agency key (ak_). Returns the updated row.

curl -X PATCH "https://mythic-analytics.gulp.workers.dev/builder/canvases/123e4567-e89b-12d3-a456-426614174000?location_id=acme-retail" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "name": "Product Launch Funnel",
  "description": "example_string",
  "is_active": true
}'

import requests
import json

url = "https://mythic-analytics.gulp.workers.dev/builder/canvases/123e4567-e89b-12d3-a456-426614174000?location_id=acme-retail"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
  "name": "Product Launch Funnel",
  "description": "example_string",
  "is_active": true
}

response = requests.patch(url, headers=headers, json=data)
print(response.json())

const response = await fetch("https://mythic-analytics.gulp.workers.dev/builder/canvases/123e4567-e89b-12d3-a456-426614174000?location_id=acme-retail", {
  method: "PATCH",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
},
  body: JSON.stringify({
  "name": "Product Launch Funnel",
  "description": "example_string",
  "is_active": true
})
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
    "bytes"
    "encoding/json"
)

func main() {
    data := []byte(`{
  "name": "Product Launch Funnel",
  "description": "example_string",
  "is_active": true
}`)

    req, err := http.NewRequest("PATCH", "https://mythic-analytics.gulp.workers.dev/builder/canvases/123e4567-e89b-12d3-a456-426614174000?location_id=acme-retail", bytes.NewBuffer(data))
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

require 'net/http'
require 'json'

uri = URI('https://mythic-analytics.gulp.workers.dev/builder/canvases/123e4567-e89b-12d3-a456-426614174000?location_id=acme-retail')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.body = '{
  "name": "Product Launch Funnel",
  "description": "example_string",
  "is_active": true
}'

response = http.request(request)
puts response.body

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "tenant_key": "acme-retail",
    "name": "Product Launch Funnel",
    "description": "example_string",
    "viewport": {
      "x": 0,
      "y": 0,
      "zoom": 1
    },
    "is_active": false,
    "version": 3,
    "published_version": 2,
    "created_at": "2024-12-25T10:00:00Z",
    "updated_at": "2024-12-25T10:00:00Z"
  }
}

{
  "error": "Bad Request",
  "message": "The request contains invalid parameters or malformed data",
  "code": 400,
  "details": [
    {
      "field": "email",
      "message": "Invalid email format"
    }
  ]
}

PATCH

/canvases/{id}

PATCH

Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token

Bearer Tokenstring

Required

Builder key as a bearer token. Use an agency key for full CRUD (Bearer ak_...) or a viewer key for read-only access (Bearer sk_...). Scoped keys (mcp_) are accepted too and need canvases:read or canvases:write. See Using an mcp_ key over HTTP.

path

idstring

Required

Canvas UUID.

Format: uuid

query

location_idstring

Client location to scope the request to. Required when authenticating with an agency key (ak_). Ignored for viewer keys (sk_).

Content-Typestring

Required

The media type of the request body

Options: application/json

namestring

descriptionstring

is_activeboolean

Request Preview

Response

Response will appear here after sending the request

Authentication

header

Authorizationstring

Required

Bearer token. Builder key as a bearer token. Use an agency key for full CRUD (Bearer ak_...) or a viewer key for read-only access (Bearer sk_...). Scoped keys (mcp_) are accepted too and need canvases:read or canvases:write. See Using an mcp_ key over HTTP.