enhancedocs
For agentsOpen Enhance ↗
Reference / canvas.document.save

Enhance documentation

canvas.document.save

Replace a canvas document. A stale base version exits 5 as CONFLICT; read, merge, and retry.

↓ Markdown

canvas.document.save

mutation write

Use when the requested change exactly matches canvas.document.save; read the current state first when a version or identifier may have changed.

Before calling

  • Authenticate as the accountable Enhance person.
  • Use only resource identifiers returned by an earlier capability result or supplied by the person.
  • Reuse clientToken only when retrying this exact mutation input.

Input

Show complete JSON Schema 
{
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "type": "object",
 "properties": {
  "canvasId": {
   "type": "string",
   "format": "uuid",
   "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
  },
  "baseVersion": {
   "type": "integer",
   "minimum": 1,
   "maximum": 9007199254740991
  },
  "document": {
   "type": "object",
   "propertyNames": {
    "type": "string"
   },
   "additionalProperties": {}
  },
  "screenIds": {
   "maxItems": 2000,
   "type": "array",
   "items": {
    "type": "string",
    "format": "uuid",
    "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
   }
  }
 },
 "required": [
  "canvasId",
  "baseVersion",
  "document",
  "screenIds"
 ],
 "additionalProperties": false
}

Example

Show example input 
{
 "canvasId": "00000000-0000-4000-8000-000000000010",
 "baseVersion": 1,
 "document": {
  "version": 3,
  "nodes": {
   "root": {
    "id": "root",
    "label": "Canvas",
    "component": "root",
    "labelOrigin": "generated",
    "visible": true,
    "locked": false,
    "styles": {}
   }
  },
  "relationships": {},
  "tombstones": {}
 },
 "screenIds": []
}

Result

Returns a typed canvas.document.save result from the Enhance API without transport-specific prose.

Recovery

  • BAD_REQUEST: correct the named fields and call again.
  • UNAUTHORIZED: restore Enhance authentication, then retry once.
  • FORBIDDEN or NOT_FOUND: check the supplied resource and selection; do not substitute unrelated content. Ask for corrected access or scope if needed.
  • CONFLICT: read the current resource, merge the intended change, and retry with its version.
  • INTERNAL: run Enhance diagnostics, report the failure, and stop repeating the call.

Continue with

  • Read the affected canvas resource to confirm the result.

Compatibility: 085c52017941a3435c78d78a541f0e81114eef79788c53ffdb3d0ae4f3e8d0b3.