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

# Create design merge job

<Warning>
  This API is currently provided as a preview. Be aware of the following:

  * There might be unannounced breaking changes.
  * Any breaking changes to preview APIs won't produce a new [API version](https://www.canva.dev/docs/apps/rest-apis/versions/).
  * Public apps that use preview APIs will not pass the review process, and can't be made available to all Canva users.
</Warning>

Starts a new [asynchronous job](https://www.canva.dev/docs/apps/rest-apis/requests-responses/#asynchronous-job-endpoints) to merge design pages by applying page operations (such as insert, move, or delete) to produce a new design or modify an existing one.

When the job completes successfully, the job result includes metadata for the created or updated design.

<Note>
  At this stage, only a single operation per request is supported by default, and passing multiple operations will fail. Contact Canva to enable multi-operation mode for your app.
</Note>

<Note>
  For more information on the workflow for using asynchronous jobs, see [API requests and responses](https://www.canva.dev/docs/apps/rest-apis/requests-responses/#asynchronous-job-endpoints). You can check the status and get the results of jobs created with this API using the [Get design merge job API](https://www.canva.dev/docs/apps/rest-apis/reference/merges/get-design-merge-job/).
</Note>

## HTTP method and URL path

POST https\://api.canva.com/rest/v1/merges

This operation is rate limited to 100 requests per minute for each user of your app.

## Authentication and authorization

This endpoint requires a valid access token that acts on behalf of a user. For more information, see [Generate an access token](/docs/apps/rest-apis/reference/authentication/generate-access-token).

### Scopes

The access token must have all the following [scopes](/docs/apps/rest-apis/scopes) (permissions):

* `design:content:write`
* `design:meta:read`

## Header parameters

<Prop.List>
  <Prop name="Authorization" type="string" required>
    Provides credentials to authenticate the request, in the form of a `Bearer` token.

    For example: `Authorization: Bearer {token}`
  </Prop>

  <Prop name="Content-Type" type="string" required>
    Indicates the media type of the information sent in the request. This must be set to `application/json`.

    For example: `Content-Type: application/json`
  </Prop>
</Prop.List>

## Body parameters

<Tabs>
  <Tab name="create_new_design">
    Creates a new design by inserting pages from other designs.

    <Prop.List>
      <Prop name="type" type="string" required>
        The type of merge job to create.

        <Prop.Extras>
          **Available values:** The only valid value is `create_new_design`.
        </Prop.Extras>
      </Prop>

      <Prop name="operations" type="DesignMergeOperation[]" required>
        For this job type, only insert operations are supported.

        <Prop.Extras>
          **Minimum items:** `1`

          **Maximum items:** `500`
        </Prop.Extras>

        <Tabs>
          <Tab name="insert_pages">
            Inserts pages from a source design into the target design.

            <Prop.List>
              <Prop name="type" type="string" required>
                The type of merge operation.

                <Prop.Extras>
                  **Available values:** The only valid value is `insert_pages`.
                </Prop.Extras>
              </Prop>

              <Prop name="source" type="MergeSourceForInsertPagesOperation" required>
                <Tabs>
                  <Tab name="design">
                    A design source from which pages are inserted.

                    <Prop.List>
                      <Prop name="type" type="string" required>
                        The type of source to insert pages from.

                        <Prop.Extras>
                          **Available values:** The only valid value is `design`.
                        </Prop.Extras>
                      </Prop>

                      <Prop name="design_id" type="string" required>
                        The ID of the source design.
                      </Prop>

                      <Prop name="page_numbers" type="integer[]">
                        One-based page numbers to insert from the source design. If omitted, all pages from the design are inserted.

                        <Prop.Extras>
                          **Minimum items:** `1`
                        </Prop.Extras>
                      </Prop>
                    </Prop.List>
                  </Tab>
                </Tabs>
              </Prop>

              <Prop name="after_page_number" type="integer">
                Insert after this one-based page number in the evolving target layout. Use 0 to insert at the beginning, and the default is inserting at the end (append).
              </Prop>
            </Prop.List>
          </Tab>

          <Tab name="move_pages">
            Moves pages within the target design to a new position.

            <Prop.List>
              <Prop name="type" type="string" required>
                The type of merge operation.

                <Prop.Extras>
                  **Available values:** The only valid value is `move_pages`.
                </Prop.Extras>
              </Prop>

              <Prop name="from_page_numbers" type="integer[]" required>
                One-based number of the pages to move (evaluated at the time this operation runs). Pages are moved in order.

                <Prop.Extras>
                  **Minimum items:** `1`
                </Prop.Extras>
              </Prop>

              <Prop name="to_after_page_number" type="integer" required>
                Destination position: insert the moved pages after this one-based page number. Use 0 to move to the beginning.
              </Prop>
            </Prop.List>
          </Tab>

          <Tab name="delete_pages">
            Deletes pages from the target design.

            <Prop.List>
              <Prop name="type" type="string" required>
                The type of merge operation.

                <Prop.Extras>
                  **Available values:** The only valid value is `delete_pages`.
                </Prop.Extras>
              </Prop>

              <Prop name="page_numbers" type="integer[]" required>
                One-based numbers of the pages to delete (evaluated at the time this operation runs). Pages are deleted in reverse order to maintain page numbers.

                <Prop.Extras>
                  **Minimum items:** `1`
                </Prop.Extras>
              </Prop>
            </Prop.List>
          </Tab>
        </Tabs>
      </Prop>

      <Prop name="title" type="string" required>
        Title for the new design.

        <Prop.Extras>
          **Minimum length:** `1`

          **Maximum length:** `255`
        </Prop.Extras>
      </Prop>
    </Prop.List>
  </Tab>

  <Tab name="modify_existing_design">
    Modifies an existing design by inserting, moving, or deleting pages.

    <Prop.List>
      <Prop name="type" type="string" required>
        The type of merge job to create.

        <Prop.Extras>
          **Available values:** The only valid value is `modify_existing_design`.
        </Prop.Extras>
      </Prop>

      <Prop name="design_id" type="string" required>
        The ID of the design to modify.
      </Prop>

      <Prop name="operations" type="DesignMergeOperation[]" required>
        Supports insert, move, and delete operations.

        <Prop.Extras>
          **Minimum items:** `1`

          **Maximum items:** `500`
        </Prop.Extras>

        <Tabs>
          <Tab name="insert_pages">
            Inserts pages from a source design into the target design.

            <Prop.List>
              <Prop name="type" type="string" required>
                The type of merge operation.

                <Prop.Extras>
                  **Available values:** The only valid value is `insert_pages`.
                </Prop.Extras>
              </Prop>

              <Prop name="source" type="MergeSourceForInsertPagesOperation" required>
                <Tabs>
                  <Tab name="design">
                    A design source from which pages are inserted.

                    <Prop.List>
                      <Prop name="type" type="string" required>
                        The type of source to insert pages from.

                        <Prop.Extras>
                          **Available values:** The only valid value is `design`.
                        </Prop.Extras>
                      </Prop>

                      <Prop name="design_id" type="string" required>
                        The ID of the source design.
                      </Prop>

                      <Prop name="page_numbers" type="integer[]">
                        One-based page numbers to insert from the source design. If omitted, all pages from the design are inserted.

                        <Prop.Extras>
                          **Minimum items:** `1`
                        </Prop.Extras>
                      </Prop>
                    </Prop.List>
                  </Tab>
                </Tabs>
              </Prop>

              <Prop name="after_page_number" type="integer">
                Insert after this one-based page number in the evolving target layout. Use 0 to insert at the beginning, and the default is inserting at the end (append).
              </Prop>
            </Prop.List>
          </Tab>

          <Tab name="move_pages">
            Moves pages within the target design to a new position.

            <Prop.List>
              <Prop name="type" type="string" required>
                The type of merge operation.

                <Prop.Extras>
                  **Available values:** The only valid value is `move_pages`.
                </Prop.Extras>
              </Prop>

              <Prop name="from_page_numbers" type="integer[]" required>
                One-based number of the pages to move (evaluated at the time this operation runs). Pages are moved in order.

                <Prop.Extras>
                  **Minimum items:** `1`
                </Prop.Extras>
              </Prop>

              <Prop name="to_after_page_number" type="integer" required>
                Destination position: insert the moved pages after this one-based page number. Use 0 to move to the beginning.
              </Prop>
            </Prop.List>
          </Tab>

          <Tab name="delete_pages">
            Deletes pages from the target design.

            <Prop.List>
              <Prop name="type" type="string" required>
                The type of merge operation.

                <Prop.Extras>
                  **Available values:** The only valid value is `delete_pages`.
                </Prop.Extras>
              </Prop>

              <Prop name="page_numbers" type="integer[]" required>
                One-based numbers of the pages to delete (evaluated at the time this operation runs). Pages are deleted in reverse order to maintain page numbers.

                <Prop.Extras>
                  **Minimum items:** `1`
                </Prop.Extras>
              </Prop>
            </Prop.List>
          </Tab>
        </Tabs>
      </Prop>

      <Prop name="title" type="string">
        Optional new title for the design.

        <Prop.Extras>
          **Minimum length:** `1`

          **Maximum length:** `255`
        </Prop.Extras>
      </Prop>
    </Prop.List>
  </Tab>
</Tabs>

## Example request

Examples for using the `/v1/merges` endpoint:

<Tabs storageKey="example.language" disableContentTransition>
  <Tab name="cURL">
    ```sh
    curl --request POST 'https://api.canva.com/rest/v1/merges' \
    --header 'Authorization: Bearer {token}' \
    --header 'Content-Type: application/json' \
    --data '{
      "type": "create_new_design",
      "operations": [
        {
          "type": "insert_pages",
          "source": {
            "type": "design",
            "design_id": "DAFVztcvd9z",
            "page_numbers": [
              1,
              2
            ]
          },
          "after_page_number": 2
        },
        {
          "type": "move_pages",
          "from_page_numbers": [
            1,
            3
          ],
          "to_after_page_number": 2
        },
        {
          "type": "delete_pages",
          "page_numbers": [
            2,
            4
          ]
        }
      ],
      "title": "My merged design"
    }'
    ```
  </Tab>

  <Tab name="Node.js">
    ```js
    const fetch = require("node-fetch");

    fetch("https://api.canva.com/rest/v1/merges", {
      method: "POST",
      headers: {
        "Authorization": "Bearer {token}",
        "Content-Type": "application/json",
      },
      body: JSON.stringify({
        "type": "create_new_design",
        "operations": [
          {
            "type": "insert_pages",
            "source": {
              "type": "design",
              "design_id": "DAFVztcvd9z",
              "page_numbers": [
                1,
                2
              ]
            },
            "after_page_number": 2
          },
          {
            "type": "move_pages",
            "from_page_numbers": [
              1,
              3
            ],
            "to_after_page_number": 2
          },
          {
            "type": "delete_pages",
            "page_numbers": [
              2,
              4
            ]
          }
        ],
        "title": "My merged design"
      }),
    })
      .then(async (response) => {
        const data = await response.json();
        console.log(data);
      })
      .catch(err => console.error(err));
    ```
  </Tab>

  <Tab name="Java">
    ```java
    import java.io.IOException;
    import java.net.URI;
    import java.net.http.*;

    public class ApiExample {
        public static void main(String[] args) throws IOException, InterruptedException {
            HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://api.canva.com/rest/v1/merges"))
                .header("Authorization", "Bearer {token}")
                .header("Content-Type", "application/json")
                .method("POST", HttpRequest.BodyPublishers.ofString("{\"type\": \"create_new_design\", \"operations\": [{\"type\": \"insert_pages\", \"source\": {\"type\": \"design\", \"design_id\": \"DAFVztcvd9z\", \"page_numbers\": [1, 2]}, \"after_page_number\": 2}, {\"type\": \"move_pages\", \"from_page_numbers\": [1, 3], \"to_after_page_number\": 2}, {\"type\": \"delete_pages\", \"page_numbers\": [2, 4]}], \"title\": \"My merged design\"}"))
                .build();

            HttpResponse<String> response = HttpClient.newHttpClient().send(
                request,
                HttpResponse.BodyHandlers.ofString()
            );
            System.out.println(response.body());
        }
    }
    ```
  </Tab>

  <Tab name="Python">
    ```py
    import requests

    headers = {
        "Authorization": "Bearer {token}",
        "Content-Type": "application/json"
    }

    data = {
        "type": "create_new_design",
        "operations": [
            {
                "type": "insert_pages",
                "source": {
                    "type": "design",
                    "design_id": "DAFVztcvd9z",
                    "page_numbers": [
                        1,
                        2
                    ]
                },
                "after_page_number": 2
            },
            {
                "type": "move_pages",
                "from_page_numbers": [
                    1,
                    3
                ],
                "to_after_page_number": 2
            },
            {
                "type": "delete_pages",
                "page_numbers": [
                    2,
                    4
                ]
            }
        ],
        "title": "My merged design"
    }

    response = requests.post("https://api.canva.com/rest/v1/merges",
        headers=headers,
        json=data
    )
    print(response.json())
    ```
  </Tab>

  <Tab name="C#">
    ```csharp
    using System.Net.Http;

    var client = new HttpClient();
    var request = new HttpRequestMessage
    {
      Method = HttpMethod.Post,
      RequestUri = new Uri("https://api.canva.com/rest/v1/merges"),
      Headers =
      {
        { "Authorization", "Bearer {token}" },
      },
      Content = new StringContent(
        "{\"type\": \"create_new_design\", \"operations\": [{\"type\": \"insert_pages\", \"source\": {\"type\": \"design\", \"design_id\": \"DAFVztcvd9z\", \"page_numbers\": [1, 2]}, \"after_page_number\": 2}, {\"type\": \"move_pages\", \"from_page_numbers\": [1, 3], \"to_after_page_number\": 2}, {\"type\": \"delete_pages\", \"page_numbers\": [2, 4]}], \"title\": \"My merged design\"}",
        Encoding.UTF8,
        "application/json"
      ),
    };

    using (var response = await client.SendAsync(request))
    {
      response.EnsureSuccessStatusCode();
      var body = await response.Content.ReadAsStringAsync();
      Console.WriteLine(body);
    };
    ```
  </Tab>

  <Tab name="Go">
    ```go
    package main

    import (
    	"fmt"
    	"io"
    	"net/http"
    	"strings"
    )

    func main() {
    	payload := strings.NewReader(`{
    	  "type": "create_new_design",
    	  "operations": [
    	    {
    	      "type": "insert_pages",
    	      "source": {
    	        "type": "design",
    	        "design_id": "DAFVztcvd9z",
    	        "page_numbers": [
    	          1,
    	          2
    	        ]
    	      },
    	      "after_page_number": 2
    	    },
    	    {
    	      "type": "move_pages",
    	      "from_page_numbers": [
    	        1,
    	        3
    	      ],
    	      "to_after_page_number": 2
    	    },
    	    {
    	      "type": "delete_pages",
    	      "page_numbers": [
    	        2,
    	        4
    	      ]
    	    }
    	  ],
    	  "title": "My merged design"
    	}`)

    	url := "https://api.canva.com/rest/v1/merges"
    	req, _ := http.NewRequest("POST", url, payload)
    	req.Header.Add("Authorization", "Bearer {token}")
    	req.Header.Add("Content-Type", "application/json")

    	res, _ := http.DefaultClient.Do(req)
    	defer res.Body.Close()
    	body, _ := io.ReadAll(res.Body)
    	fmt.Println(string(body))
    }
    ```
  </Tab>

  <Tab name="PHP">
    ```php
    $curl = curl_init();
    curl_setopt_array($curl, array(
      CURLOPT_URL => "https://api.canva.com/rest/v1/merges",
      CURLOPT_CUSTOMREQUEST => "POST",
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_HTTPHEADER => array(
        'Authorization: Bearer {token}',
        'Content-Type: application/json',
      ),
      CURLOPT_POSTFIELDS => json_encode([
        "type" => "create_new_design",
        "operations" => [
          [
            "type" => "insert_pages",
            "source" => [
              "type" => "design",
              "design_id" => "DAFVztcvd9z",
              "page_numbers" => [
                1,
                2
              ]
            ],
            "after_page_number" => 2
          ],
          [
            "type" => "move_pages",
            "from_page_numbers" => [
              1,
              3
            ],
            "to_after_page_number" => 2
          ],
          [
            "type" => "delete_pages",
            "page_numbers" => [
              2,
              4
            ]
          ]
        ],
        "title" => "My merged design"
      ])
    ));

    $response = curl_exec($curl);
    $err = curl_error($curl);
    curl_close($curl);

    if (empty($err)) {
      echo $response;
    } else {
      echo "Error: " . $err;
    }
    ```
  </Tab>

  <Tab name="Ruby">
    ```ruby
    require 'net/http'
    require 'uri'

    url = URI('https://api.canva.com/rest/v1/merges')
    http = Net::HTTP.new(url.host, url.port)
    http.use_ssl = true

    request = Net::HTTP::Post.new(url)
    request['Authorization'] = 'Bearer {token}'
    request['Content-Type'] = 'application/json'
    request.body = <<REQUEST_BODY
    {
      "type": "create_new_design",
      "operations": [
        {
          "type": "insert_pages",
          "source": {
            "type": "design",
            "design_id": "DAFVztcvd9z",
            "page_numbers": [
              1,
              2
            ]
          },
          "after_page_number": 2
        },
        {
          "type": "move_pages",
          "from_page_numbers": [
            1,
            3
          ],
          "to_after_page_number": 2
        },
        {
          "type": "delete_pages",
          "page_numbers": [
            2,
            4
          ]
        }
      ],
      "title": "My merged design"
    }
    REQUEST_BODY

    response = http.request(request)
    puts response.read_body
    ```
  </Tab>
</Tabs>

## Success response

If successful, the endpoint returns a `200` response with a JSON body with the following parameters:

<Prop.List>
  <Prop name="job" type="DesignMergeJob" required mode="output">
    The details of a design merge job.

    <PillAccordion title={<>Properties of <strong>job</strong></>} defaultExpanded={true}>
      <Prop.List>
        <Prop name="id" type="string" required mode="output">
          The ID of the design merge job.
        </Prop>

        <Prop name="status" type="string" required mode="output">
          <Prop.Extras>
            **Available values:**

            * `in_progress`: The merge job is still running.
            * `success`: The merge job completed successfully.
            * `failed`: The merge job failed.
          </Prop.Extras>
        </Prop>

        <Prop name="result" type="DesignMergeJobResult" mode="output">
          <PillAccordion title={<>Properties of <strong>result</strong></>}>
            <Prop.List>
              <Prop name="design" type="DesignSummary" required mode="output">
                Basic details about the design, such as the design's ID, title, and URL.

                <PillAccordion title={<>Properties of <strong>design</strong></>}>
                  <Prop.List>
                    <Prop name="id" type="string" required mode="output">
                      The design ID.
                    </Prop>

                    <Prop name="urls" type="DesignLinks" required mode="output">
                      A temporary set of URLs for viewing or editing the design.

                      <PillAccordion title={<>Properties of <strong>urls</strong></>}>
                        <Prop.List>
                          <Prop name="edit_url" type="string" required mode="output">
                            A temporary editing URL for the design. This URL is only accessible to the user that made the API request, and is designed to support [return navigation](https://www.canva.dev/docs/apps/rest-apis/return-navigation-guide/) workflows.

                            NOTE: This is not a permanent URL, it is only valid for 30 days.
                          </Prop>

                          <Prop name="view_url" type="string" required mode="output">
                            A temporary viewing URL for the design. This URL is only accessible to the user that made the API request, and is designed to support [return navigation](https://www.canva.dev/docs/apps/rest-apis/return-navigation-guide/) workflows.

                            NOTE: This is not a permanent URL, it is only valid for 30 days.
                          </Prop>
                        </Prop.List>
                      </PillAccordion>
                    </Prop>

                    <Prop name="created_at" type="integer" required mode="output">
                      When the design was created in Canva, as a Unix timestamp (in seconds since the Unix
                      Epoch).
                    </Prop>

                    <Prop name="updated_at" type="integer" required mode="output">
                      When the design was last updated in Canva, as a Unix timestamp (in seconds since the
                      Unix Epoch).
                    </Prop>

                    <Prop name="title" type="string" mode="output">
                      The design title.
                    </Prop>

                    <Prop name="url" type="string" mode="output">
                      URL of the design.
                    </Prop>

                    <Prop name="thumbnail" type="Thumbnail" mode="output">
                      A thumbnail image representing the object.

                      <PillAccordion title={<>Properties of <strong>thumbnail</strong></>}>
                        <Prop.List>
                          <Prop name="width" type="integer" required mode="output">
                            The width of the thumbnail image in pixels.
                          </Prop>

                          <Prop name="height" type="integer" required mode="output">
                            The height of the thumbnail image in pixels.
                          </Prop>

                          <Prop name="url" type="string" required mode="output">
                            A URL for retrieving the thumbnail image.
                            This URL expires after 15 minutes. This URL includes a query string
                            that's required for retrieving the thumbnail.
                          </Prop>
                        </Prop.List>
                      </PillAccordion>
                    </Prop>

                    <Prop name="page_count" type="integer" mode="output">
                      The total number of pages in the design. Some design types don't have pages (for example, Canva docs).
                    </Prop>
                  </Prop.List>
                </PillAccordion>
              </Prop>
            </Prop.List>
          </PillAccordion>
        </Prop>

        <Prop name="error" type="DesignMergeError" mode="output">
          If the merge job fails, this object provides details about the error.

          <PillAccordion title={<>Properties of <strong>error</strong></>}>
            <Prop.List>
              <Prop name="code" type="string" required mode="output">
                <Prop.Extras>
                  **Available values:**

                  * `thumbnail_generation_error`
                  * `merge_error`
                  * `create_design_error`
                  * `modify_design_error`
                </Prop.Extras>
              </Prop>

              <Prop name="message" type="string" required mode="output">
                A human-readable description of what went wrong.
              </Prop>
            </Prop.List>
          </PillAccordion>
        </Prop>
      </Prop.List>
    </PillAccordion>
  </Prop>
</Prop.List>

## Example response

```json
{
  "job": {
    "id": "a7by3wd-abc123",
    "status": "in_progress",
    "result": {
      "design": {
        "id": "DAFVztcvd9z",
        "title": "My summer holiday",
        "url": "https://www.canva.com/design/DAFVztcvd9z/edit",
        "thumbnail": {
          "width": 595,
          "height": 335,
          "url": "https://document-export.canva.com/Vczz9/zF9vzVtdADc/2/thumbnail/0001.png?<query-string>"
        },
        "urls": {
          "edit_url": "https://www.canva.com/api/design/eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIiwiZXhwaXJ5IjoxNzQyMDk5NDAzMDc5fQ..GKLx2hrJa3wSSDKQ.hk3HA59qJyxehR-ejzt2DThBW0cbRdMBz7Fb5uCpwD-4o485pCf4kcXt_ypUYX0qMHVeZ131YvfwGPIhbk-C245D8c12IIJSDbZUZTS7WiCOJZQ.sNz3mPSQxsETBvl_-upMYA/edit",
          "view_url": "https://www.canva.com/api/design/eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIiwiZXhwaXJ5IjoxNzQyMDk5NDAzMDc5fQ..GKLx2hrJa3wSSDKQ.hk3HA59qJyxehR-ejzt2DThBW0cbRdMBz7Fb5uCpwD-4o485pCf4kcXt_ypUYX0qMHVeZ131YvfwGPIhbk-C245D8c12IIJSDbZUZTS7WiCOJZQ.sNz3mPSQxsETBvl_-upMYA/view"
        },
        "created_at": 1377396000,
        "updated_at": 1692928800,
        "page_count": 3
      }
    },
    "error": {
      "code": "thumbnail_generation_error",
      "message": "The merge job failed due to an internal error."
    }
  }
}
```

## Error responses

### 400 Bad Request

<Prop.List>
  <Prop name="code" type="string" required mode="output">
    A short string indicating what failed. This field can be used to handle errors programmatically. For a complete list of error codes, see [Error responses](/docs/apps/rest-apis/error-responses/).
  </Prop>

  <Prop name="message" type="string" required mode="output">
    A human-readable description of what went wrong.
  </Prop>
</Prop.List>

#### Example error responses

##### Invalid merge job type

```json
{
  "code": "invalid_request",
  "message": "Invalid merge job type: {jobType}"
}
```

##### Invalid operation

```json
{
  "code": "bad_request_params",
  "message": "Invalid operation: {message}"
}
```

##### Invalid page number

```json
{
  "code": "bad_request_params",
  "message": "Page number {pageNumber} is out of range (design has {totalPages} pages)"
}
```

##### Unsupported page type

```json
{
  "code": "bad_request_params",
  "message": "Source design '{designId}' has unsupported page type: {pageType}. Only fixed pages are supported."
}
```

##### Unsupported document type

```json
{
  "code": "bad_request_params",
  "message": "Design '{designId}' has unsupported document type: {documentType}."
}
```

##### Operation not supported

```json
{
  "code": "bad_request_params",
  "message": "{message}"
}
```

### 402 Payment Required

<Prop.List>
  <Prop name="code" type="string" required mode="output">
    A short string indicating what failed. This field can be used to handle errors programmatically. For a complete list of error codes, see [Error responses](/docs/apps/rest-apis/error-responses/).
  </Prop>

  <Prop name="message" type="string" required mode="output">
    A human-readable description of what went wrong.
  </Prop>
</Prop.List>

#### Example error responses

##### User has reached their credit quota limit

```json
{
  "code": "credit_quota_exceeded",
  "message": "User has exceeded their credit quota"
}
```

##### App has reached its credit quota limit

```json
{
  "code": "app_credit_quota_exceeded",
  "message": "App has exceeded its credit quota"
}
```

### 403 Forbidden

<Prop.List>
  <Prop name="code" type="string" required mode="output">
    A short string indicating what failed. This field can be used to handle errors programmatically. For a complete list of error codes, see [Error responses](/docs/apps/rest-apis/error-responses/).
  </Prop>

  <Prop name="message" type="string" required mode="output">
    A human-readable description of what went wrong.
  </Prop>
</Prop.List>

#### Example error responses

##### Not allowed to access design

```json
{
  "code": "permission_denied",
  "message": "Not allowed to access design '{designId}'"
}
```

##### Unauthorized access to private resource

```json
{
  "code": "permission_denied",
  "message": "Source design contains private resources that you don't have access to."
}
```

### 404 Not Found

<Prop.List>
  <Prop name="code" type="string" required mode="output">
    A short string indicating what failed. This field can be used to handle errors programmatically. For a complete list of error codes, see [Error responses](/docs/apps/rest-apis/error-responses/).
  </Prop>

  <Prop name="message" type="string" required mode="output">
    A human-readable description of what went wrong.
  </Prop>
</Prop.List>

#### Example error response

##### Design not found for merge operation

```json
{
  "code": "not_found",
  "message": "Design '{designId}' not found"
}
```

### 413 Request Entity Too Large

<Prop.List>
  <Prop name="code" type="string" required mode="output">
    A short string indicating what failed. This field can be used to handle errors programmatically. For a complete list of error codes, see [Error responses](/docs/apps/rest-apis/error-responses/).
  </Prop>

  <Prop name="message" type="string" required mode="output">
    A human-readable description of what went wrong.
  </Prop>
</Prop.List>

#### Example error response

##### Request too large

```json
{
  "code": "bad_request_params",
  "message": "The request size exceeds the maximum allowed limit. Try reducing the number of pages per request, using simpler page content, or splitting into multiple smaller operations."
}
```