CreatePageBody

Request body for creating a Page.

Definition

TypeScript

interface CreatePageBody {
  workspaceId: string;
  title: string;
  slug?: string | undefined;
  body?: string | undefined;
  parentId?: string | null | undefined;
  kind?: "dashboard" | "page" | undefined;
}

Fields

Field	Type	Notes
`workspaceId`	`string`	`required` — Workspace that will own the new page.
`title`	`string`	`required` — Display title.
`slug`	`string \| undefined`	`optional` — Optional override. Defaults to slugify(title). Must be kebab-case, unique among siblings, and not a reserved slug.
`body`	`string \| undefined`	`optional` — MDX source. Defaults to an empty string.
`parentId`	`string \| null \| undefined`	`optional` — Parent page. Must be null for dashboards.
`kind`	`"dashboard" \| "page" \| undefined`	`optional` — Defaults to `page`. Dashboards must have `parentId = null`.