canvas.setAccess

mutation write

Use when the requested change exactly matches canvas.setAccess; 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

{
 "$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)$"
  },
  "accessState": {
   "type": "string",
   "enum": [
    "invite-only",
    "link-view",
    "link-comment"
   ]
  }
 },
 "required": [
  "canvasId",
  "accessState"
 ],
 "additionalProperties": false
}

Example

{
 "canvasId": "00000000-0000-4000-8000-000000000010",
 "accessState": "invite-only"
}

Result

Returns a typed canvas.setAccess 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: 593b353fff87a46e1fcc69c0bde794b806856a41a213f69baff3503a247f9a2f.