Enhance documentation

enhance-dev canvas set-review-state

Change the authenticated person’s review state on a canvas.

enhance-dev canvas set-review-state

enhance-dev canvas set-review-state [options]

Arguments

This command takes no positional arguments.

Options

Option	Required	Default	Meaning
`--canvas-id <string>`	Yes	None	Canvas id, from `enhance canvas list`.
`--review-state <string>`	No	None	Review state to store: not-started, in-progress, or done.
`--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.setReviewState. 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)$"},"reviewState":{"type":"string","enum":["not-started","in-progress","done"]}},"required":["canvasId","reviewState"]}

Output

This command writes JSON records to standard output. Returns a typed canvas.setReviewState 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":{"reviewState":{"anyOf":[{"type":"string","enum":["not-started","in-progress","done"]},{"type":"null"}]}},"required":["reviewState"],"additionalProperties":false}

Examples

enhance-dev canvas set-review-state --canvas-id <string>

Show example input

{
 "canvasId": "00000000-0000-4000-8000-000000000010",
 "reviewState": "not-started"
}

Show example output

{
 "reviewState": "not-started"
}

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.