Copy Document

Copies one of the requesting user's existing documents, with the specified title. Requires title and template (the ID of the document to copy). Optionally, a parent folder can be provided. Note that collaborator permissions are not transferred to the copied document.

📘

This endpoint can only create a new Lucidchart or Lucidspark document. It cannot modify an existing document's contents.

📘
Document Creation Location

When there is no parent field on the request, the new document will be created in a default location depending on the authorizing token's scopes.

  • If the token authorizing the request uses one of the document.app scopes, then the document will be created in an app-specific folder.
  • If one of the document.content scopes is used, the document will be created in the user's 'My Documents folder'.
  • If both types of scopes are authorized on the token, the document.content behavior will take priority and the document will be created in the user's 'My Documents' folder.

Valid Authentication Methods

API Key Grants:

  • DocumentEdit

OAuth 2.0 User Token Scopes:

  • lucidchart.document.content
  • lucidchart.document.app.folder
  • lucidspark.document.content
  • lucidspark.document.app.folder
Body Params
string
required

Title that should be given to the copied document.

uuid
required

ID of the document to copy.

number

Folder ID for the new document.

Responses

403

Forbidden.

  • if the user doesn't have access to or permissions to create within the specified parent folder.
  • if the user doesn't have permissions to access the specified template to copy from.
  • if the token authorizing the request has the document.app scope with a specified parent folder that is outside the app folder's folder tree.
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json