Create Document with Standard Import File

Creates a new document from a Lucid Standard Import file (.zip archive) uploaded as multipart/form-data. Requires file, type, and product. Optionally, a title and parent folder can be provided. If no title is provided, the new document's title will be the imported filename.

📘

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

Standard Import

For more information on how to use the Standard Import, refer to the extensive reference documentation here.

For examples of how to use the Standard Import, refer to the /standard-import folder in Lucid's repository of Sample Lucid REST Applications. This repo also contains some example .zip Standard Import files you can reference or use in your own projects.

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
file
required

The Lucid Standard Import specification (.zip archive) from which to create the document.

string
enum
required
Allowed:
string
enum
required

The Lucid Suite product types that can be created.

Allowed:
string

Title that should be given to the newly created document. If no title is specified, the document will be automatically assigned the file name.

number

Folder ID for the new document.

Responses

400

Bad Request.

  • Invalid request body — the provided payload does not conform to the Lucid Standard Import schema.
403

Forbidden.

  • if the user doesn't have access to or permissions to create within the specified parent folder.
  • 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.
  • if the token does not have the correct scope for the import type.
415

Unsupported Media Type. The file type provided is not supported.

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json