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 LocationWhen there is no
parentfield 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.appscopes, then the document will be created in anapp-specific folder.- If one of the
document.contentscopes 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.contentbehavior will take priority and the document will be created in the user's 'My Documents' folder.
Standard ImportFor 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-importfolder in Lucid's repository of Sample Lucid REST Applications. This repo also contains some example.zipStandard 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.contentlucidchart.document.app.folderlucidspark.document.contentlucidspark.document.app.folder
400Bad Request.
- Invalid request body — the provided payload does not conform to the Lucid Standard Import schema.
403Forbidden.
- 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.
415Unsupported Media Type. The file type provided is not supported.