Skip to main content
POST
Import Canvas Pages

Authorizations

Authorization
string
header
required

API key from Settings > Developer > REST API

Headers

Moda-Version
enum<string>
default:2026-05-01

Calendar-dated API version pin. New integrations should pin 2026-05-01 to opt into the newest response shapes. For back-compat the server also accepts requests with no header and resolves them to the current default (today: 2026-04-12); that default advances on each sunset date. Any unsupported value returns 400 unsupported_version.

Available options:
2026-04-12,
2026-05-01
Example:

"2026-05-01"

Path Parameters

canvas_ref
string
required

Body

application/json
source
string
required

Source canvas: a CANVAS_REF (cvs_ wire id or bare UUID) or a share token.

Required string length: 1 - 300
page_ids
string[] | null

Source page ids to import (real ids, or short p-refs from a prior source-state read). Omit to import every page (an explicit empty list is rejected, never widened to all pages).

Required array length: 1 - 100 elements
expected_revision
string | null

Optional (advisory) — imports append pages.

idempotency_key
string | null
Maximum string length: 200

Response

Successful Response

The response is of type Response Canvasactionsimportpages · object.