<!-- enhance-docs page=reference/cli/canvas/rename -->
<!-- enhance-docs release-sha256=8a804cfc9a6fc6b942b8daf6a82266ad6e308291ae4351abee3346bc696d1258 -->

# enhance-dev canvas rename

```text
enhance-dev canvas rename [options]
```

## Arguments

This command takes no positional arguments.

## Options

| Option | Required | Default | Meaning |
| --- | --- | --- | --- |
| `--canvas-id <string>` | Yes | None | Canvas id, from `enhance canvas list`. |
| `--title <string>` | Yes | None | Human-readable title used to name or find the resource. |
| `--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.rename`. It has write effect and single idempotency.

<details class="reference-schema">
<summary>Show complete input JSON Schema</summary>

```json
{"$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)$"},"title":{"type":"string","minLength":1}},"required":["canvasId","title"]}
```
</details>


## Output

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

<details class="reference-schema">
<summary>Show complete output JSON Schema</summary>

```json
{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"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)$"},"title":{"type":"string","minLength":1},"accessState":{"type":"string","enum":["invite-only","link-view","link-comment","link-edit"]},"organisationId":{"anyOf":[{"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)$"},{"type":"null"}]},"sourceUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"unresolvedCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"viewerCan":{"type":"object","properties":{"read":{"type":"boolean"},"comment":{"type":"string","enum":["yes","sign-in","no"]},"edit":{"default":"no","type":"string","enum":["yes","sign-in","no"]},"grants":{"default":[],"type":"array","items":{"type":"object","properties":{"source":{"type":"string","enum":["direct","team","link"]},"accessLevel":{"type":"string","enum":["owner","can-edit","can-comment","can-view"]}},"required":["source","accessLevel"],"additionalProperties":false}},"grantableAccessLevels":{"default":[],"type":"array","items":{"type":"string","enum":["can-edit","can-comment","can-view"]}},"share":{"type":"boolean"},"manage":{"type":"boolean"},"readHistory":{"default":false,"type":"boolean"}},"required":["read","comment","edit","grants","grantableAccessLevels","share","manage","readHistory"],"additionalProperties":false},"createdAt":{"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))$"},"lastActivityAt":{"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))$"}},"required":["id","title","accessState","organisationId","sourceUrl","unresolvedCount","viewerCan","createdAt","lastActivityAt"],"additionalProperties":false}
```
</details>


## Examples

```bash
enhance-dev canvas rename --canvas-id <string> --title <string>
```

<details class="reference-schema">
<summary>Show example input</summary>

```json
{
 "canvasId": "00000000-0000-4000-8000-000000000010",
 "title": "x"
}
```
</details>

<details class="reference-schema">
<summary>Show example output</summary>

```json
{
 "id": "00000000-0000-4000-8000-000000000010",
 "title": "x",
 "accessState": "invite-only",
 "organisationId": "00000000-0000-4000-8000-000000000010",
 "sourceUrl": "x",
 "unresolvedCount": 0,
 "viewerCan": {
  "read": false,
  "comment": "yes",
  "edit": "no",
  "grants": [],
  "grantableAccessLevels": [],
  "share": false,
  "manage": false,
  "readHistory": false
 },
 "createdAt": "2026-08-10T00:00:00.000Z",
 "lastActivityAt": "2026-08-10T00:00:00.000Z"
}
```
</details>

## 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.