Enhance documentation

enhance-dev canvas invites preview

Inspect what an invitation grants before accepting it.

enhance-dev canvas invites preview

enhance-dev canvas invites preview [options]

Arguments

This command takes no positional arguments.

Options

Option	Required	Default	Meaning
`--token <string>`	No	None	Secret canvas invitation token; omit this option to read one line from stdin.
`--json <json>`	No	None	Complete procedure input as JSON; do not combine it with field flags.

Input

This command presents the capability canvas.invites.preview. It has read effect and none idempotency.

Show complete input JSON Schema

{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"token":{"type":"string","minLength":1,"maxLength":512}},"required":["token"]}

Output

This command writes JSON records to standard output. Returns a typed canvas.invites.preview 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":{"canvasTitle":{"type":"string","minLength":1},"invitedBy":{"type":"string","minLength":1},"email":{"type":"string","format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"accessLevel":{"type":"string","enum":["can-edit","can-comment","can-view"]},"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","accepted"]},"hasAccount":{"type":"boolean"}},"required":["canvasTitle","invitedBy","email","accessLevel","expiresAt","state","hasAccount"],"additionalProperties":false}

Examples

enhance-dev canvas invites preview

Show example input

{
 "token": "x"
}

Show example output

{
 "canvasTitle": "x",
 "invitedBy": "x",
 "email": "agent@example.test",
 "accessLevel": "can-edit",
 "expiresAt": "2026-08-10T00:00:00.000Z",
 "state": "pending",
 "hasAccount": false
}

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.