---
title: "Edit Canvas"
method: POST
path: "/canvases/{canvas_ref}/edit"
tags: ["canvas-actions"]
---

# Edit Canvas

`POST /canvases/{canvas_ref}/edit`

## Request

- Base URL: `https://api.moda.app/v1`
- URL: `https://api.moda.app/v1/canvases/{canvas_ref}/edit`
- Auth: HTTP bearer

Sandboxed JS batch edit. Failures are atomic; committed-but-imperfect is success + requires_repair.

The response ``revision`` is advisory-until-read (the CRDT write-back
settles asynchronously); pin only tokens obtained from reads.

## Path parameters

- `canvas_ref` string, required

## Headers

- `Moda-Version` '2026-04-12' | '2026-05-01'

## Request body

- CanvasEditRequest
  - `code` string, required: Sandboxed JS batch edit program.
  - `page_id` string, nullable: Scope the nodes snapshot to one page.
  - `expected_revision` string, required: Revision token from your last read. Stale -> typed stale_revision.
  - `idempotency_key` string, nullable

## Response `200`

Successful Response

- object

## Other responses

- `401`: Authentication required.
- `402`: Insufficient credits for a metered operation.
- `403`: Permission denied for this scope.
- `404`: Resource not found.
- `409`: Conflict (idempotency / resource state).
- `422`: Request validation failed.
- `429`: Rate limit exceeded.
- `500`: Internal error.

## Changes

- **2026-11-03** `9ac6a3abc0f8`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/moda/apis/moda-public-api/changes/canvases/:canvas_ref/edit/post.md)

---

[API](https://skmtc.dev/moda/apis/moda-public-api.md) - [All operations](https://skmtc.dev/moda/apis/moda-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/moda/apis/moda-public-api/revisions/9ac6a3abc0f8?raw)