enhancedocs
For agentsOpen Enhance ↗
Reference / canvas.invites.create

Enhance documentation

canvas.invites.create

Invite an email address to access a canvas and return the pending invitation.

↓ Markdown

canvas.invites.create

mutation write

Use when the requested change exactly matches canvas.invites.create; 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)$"},"email":{"type":"string","maxLength":254},"accessLevel":{"type":"string","enum":["can-edit","can-comment","can-view"]}},"required":["canvasId","email","accessLevel"]}

Example

Show example input 
{
 "canvasId": "00000000-0000-4000-8000-000000000010",
 "email": "agent@example.test",
 "accessLevel": "can-comment"
}

Result

Returns a typed canvas.invites.create 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: 1cab27ae44059b0bd3b451013549db6a77cd21aa1aa8675744dcc2cfe19ee50d.