enhancedocs
For agentsOpen Enhance ↗
Reference / canvas.remove

Enhance documentation

canvas.remove

Remove explicitly named subtrees atomically, preserving locked content and link scope.

↓ Markdown

canvas.remove

mutation write

Use when the requested change exactly matches canvas.remove; 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":{"canvasRef":{"type":"string","minLength":1},"baseVersion":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"rootNodeIds":{"minItems":1,"type":"array","items":{"type":"string","minLength":1}}},"required":["canvasRef","baseVersion","rootNodeIds"],"additionalProperties":false}

Example

Show example input 
{
 "canvasRef": "00000000-0000-4000-8000-000000000010",
 "baseVersion": 1,
 "rootNodeIds": [
  "obsolete"
 ]
}

Result

Returns a typed canvas.remove 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: c10d8f1284be6558f0b446dbfa9d4dc3d10530427705d5764c34d7db85733c78.