> ## Documentation Index
> Fetch the complete documentation index at: https://www.canva.dev/docs/apps/llms.txt
> Use this file to discover all available pages before exploring further.

# duplicatePage

API reference for the duplicatePage method.

NOTE: **This API is a preview**. Preview APIs are unstable and may change without warning. You can't release public apps using this API until it's stable.

Duplicates a page.

## Usage

### Duplicate a page by ID

```typescript
import { duplicatePage, getCurrentPageMetadata } from "@canva/design";

const currentPage = await getCurrentPageMetadata();
if (currentPage.type !== 'absolute' || currentPage.id == null) {
  throw new Error('Current page does not have an ID');
}

const pageMetadata = await duplicatePage({
  sourcePageId: currentPage.id,
  mode: 'after_source',
});
```

### Insert the duplicated page after another page

```typescript
import { addPage, duplicatePage, getCurrentPageMetadata } from "@canva/design";

const currentPage = await getCurrentPageMetadata();
if (currentPage.type !== 'absolute' || currentPage.id == null) {
  throw new Error('Current page does not have an ID');
}

const insertAfterPage = await addPage();
if (insertAfterPage.type !== 'absolute' || insertAfterPage.id == null) {
  throw new Error('Inserted page does not have an ID');
}

const pageMetadata = await duplicatePage({
  sourcePageId: currentPage.id,
  targetPageId: insertAfterPage.id,
  mode: 'after_target',
});
```

### Insert the duplicated page at the start of the design

```typescript
import { duplicatePage, getCurrentPageMetadata } from "@canva/design";

const currentPage = await getCurrentPageMetadata();
if (currentPage.type !== 'absolute' || currentPage.id == null) {
  throw new Error('Current page does not have an ID');
}

const pageMetadata = await duplicatePage({
  sourcePageId: currentPage.id,
  mode: 'before_first_page',
});
```

### Insert the duplicated page before the source page

```typescript
import { duplicatePage, getCurrentPageMetadata } from "@canva/design";

const currentPage = await getCurrentPageMetadata();
if (currentPage.type !== 'absolute' || currentPage.id == null) {
  throw new Error('Current page does not have an ID');
}

const pageMetadata = await duplicatePage({
  sourcePageId: currentPage.id,
  mode: 'before_source',
});
```

### Insert the duplicated page at the end of the design

```typescript
import { duplicatePage, getCurrentPageMetadata } from "@canva/design";

const currentPage = await getCurrentPageMetadata();
if (currentPage.type !== 'absolute' || currentPage.id == null) {
  throw new Error('Current page does not have an ID');
}

const pageMetadata = await duplicatePage({
  sourcePageId: currentPage.id,
  mode: 'after_last_page',
});
```

## Parameters

<Prop.List>
  <Prop name="opts" required state="preview" type="DuplicatePageOptions" sourceLineNumbers={[3814]}>
    Options for duplicating the page.

    <Tabs>
      <Tab name="PageInsertAtSource" icon={<StateIndicator state="preview" />}>
        Options for inserting a page adjacent to the source page.

        <Prop.List>
          <Prop name="mode" required type="string" sourceLineNumbers={[5258]}>
            The type of insertion.

            <Prop.Extras>
              **Available values**:

              * `"before_source"`
              * `"after_source"`
            </Prop.Extras>
          </Prop>

          <Prop name="sourcePageId" required type="PageId" sourceLineNumbers={[3824]}>
            The ID of the page to duplicate.
          </Prop>
        </Prop.List>
      </Tab>

      <Tab name="PageInsertAtEdge" icon={<StateIndicator state="preview" />}>
        Options for inserting a page at the start or end of the design.

        <Prop.List>
          <Prop name="mode" required type="string" sourceLineNumbers={[5247]}>
            The type of insertion.

            <Prop.Extras>
              **Available values**:

              * `"before_first_page"`
              * `"after_last_page"`
            </Prop.Extras>
          </Prop>

          <Prop name="sourcePageId" required type="PageId" sourceLineNumbers={[3824]}>
            The ID of the page to duplicate.
          </Prop>
        </Prop.List>
      </Tab>

      <Tab name="PageInsertAtTarget" icon={<StateIndicator state="preview" />}>
        Options for inserting a page adjacent to a target page.

        <Prop.List>
          <Prop name="mode" required type="string" sourceLineNumbers={[5269]}>
            The type of insertion.

            <Prop.Extras>
              **Available values**:

              * `"before_target"`
              * `"after_target"`
            </Prop.Extras>
          </Prop>

          <Prop name="targetPageId" required type="PageId" sourceLineNumbers={[5273]}>
            The ID of the page to insert the new page adjacent to.
          </Prop>

          <Prop name="sourcePageId" required type="PageId" sourceLineNumbers={[3824]}>
            The ID of the page to duplicate.
          </Prop>
        </Prop.List>
      </Tab>
    </Tabs>
  </Prop>
</Prop.List>

## Returns

The metadata of the duplicated page. This is a `Promise` that resolves with the following object:

<Tabs>
  <Tab name="AbsolutePageMetadata">
    Information about a page within a design with fixed or unbounded dimensions.

    <Prop.List>
      <Prop name="type" required type="string" sourceLineNumbers={[9]}>
        The type of page.

        The only valid value is `"absolute"`.
      </Prop>

      <Prop name="id" type="PageId" sourceLineNumbers={[13]}>
        Stable identifier for this page within the design.
      </Prop>

      <Prop name="dimensions" type="PageDimensions" sourceLineNumbers={[20]}>
        The dimensions of the page, in pixels.

        This may be `undefined` because some types of pages don't have dimensions, such as whiteboards.

        <PillAccordion defaultExpanded={false} title={<>Properties of <strong>dimensions</strong></>}>
          <Prop.List>
            <Prop name="width" required type="number" sourceLineNumbers={[5213]}>
              The width of the page, in pixels.
            </Prop>

            <Prop name="height" required type="number" sourceLineNumbers={[5217]}>
              The height of the page, in pixels.
            </Prop>
          </Prop.List>
        </PillAccordion>
      </Prop>

      <Prop name="title" type="string" sourceLineNumbers={[26]}>
        The name of the page.

        This is optional and will be empty if the user hasn't set a title.
      </Prop>
    </Prop.List>
  </Tab>

  <Tab name="UnsupportedPageMetadata">
    Pages that do not have fixed or unbounded dimensions currently do not return metadata.

    <Prop.List>
      <Prop name="type" required type="string" sourceLineNumbers={[6668]}>
        The type of page.

        The only valid value is `"unsupported"`.
      </Prop>
    </Prop.List>
  </Tab>
</Tabs>

## Permissions

To use this method, the `canva:design:content:write` permission must be enabled for the app. To learn more, see [Permissions](https://www.canva.dev/docs/apps/configuring-intents-permissions/).

## Rate limit

This method has a rate limit of 10 requests every 10 seconds.