Enhance documentation

enhance-dev canvas invites create

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

enhance-dev canvas invites create

enhance-dev canvas invites create [options]

Arguments

This command takes no positional arguments.

Options

Option	Required	Default	Meaning
`--canvas-id <string>`	Yes	None	Canvas id, from `enhance canvas list`.
`--email <string>`	Yes	None	Email address of the person to invite or add.
`--access-level <string>`	No	None	Participant access to grant: can-edit, can-comment, or can-view.
`--json <json>`	No	None	Complete procedure input as JSON; do not combine it with field flags.
`--client-token <uuid>`	No	None	Stable UUID to reuse when retrying the exact same mutation.

Input

This command presents the capability canvas.invites.create. It has write effect and single idempotency.

Show complete input 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"]}

Output

This command writes JSON records to standard output. Returns a typed canvas.invites.create result from the Enhance API without transport-specific prose.

Show complete output JSON Schema

{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"invite":{"type":"object","properties":{"inviteId":{"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"]},"sendCount":{"type":"integer","minimum":1,"maximum":9007199254740991},"lastSentAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"state":{"type":"string","enum":["pending","expired"]},"deliveryState":{"type":"string","enum":["queued","accepted","failed"]},"deliveryError":{"type":"string"}},"required":["inviteId","email","accessLevel","sendCount","lastSentAt","expiresAt","state","deliveryState","deliveryError"],"additionalProperties":false},"acceptToken":{"type":"string","maxLength":512}},"required":["invite"],"additionalProperties":false}

Examples

enhance-dev canvas invites create --canvas-id <string> --email <string>

Show example input

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

Show example output

{
 "invite": {
  "inviteId": "00000000-0000-4000-8000-000000000010",
  "email": "x",
  "accessLevel": "can-edit",
  "sendCount": 1,
  "lastSentAt": "2026-08-10T00:00:00.000Z",
  "expiresAt": "2026-08-10T00:00:00.000Z",
  "state": "pending",
  "deliveryState": "queued",
  "deliveryError": "x"
 }
}

Exit behaviour

Exit code	Meaning
`0`	The command succeeded.
`1`	The command failed for another reason (`INTERNAL`). A write may have an unknown outcome.
`2`	The command line was malformed. Nothing ran.
`3`	The API refused the input (`BAD_REQUEST`).
`4`	The credential is missing or expired (`UNAUTHORIZED`).
`5`	The API refused the request (`FORBIDDEN`, `NOT_FOUND`, `CONFLICT`, `RATE_LIMITED`).
`6`	A batch finished only in part. Retry with the same `--client-token`.

Versions

Minimum tested versions: Enhance CLI and MCP runtime 0.1.40, plugin 1.0.38, Node.js 24. No older floor is published.