Create Folder

post

https://api.lucid.co/v1/folders

Creates a new folder.

Create a new folder.

Valid Authentication Methods

API Key Grants:

FolderEdit

OAuth 2.0 User Token and Account Token Scopes:

folder
lucidchart.document.app.folder
lucidspark.document.app.folder
lucidscale.document.app.folder

Body Params

name

string

required

Name of the folder being created.

type

string

enum

required

folder - Folders can live in other folders, team folders, or the root of a user’s folder manager ("My Documents"). A folder in "My Documents" will have a null parent field.
team - Team folders can never live in another folder and are always located in the "Team Folders" section of a user's folder manager. Team folders will not have a parent field. Learn more

Allowed:

parent

Destination folder or repository to create the new folder in. For repositories, use the repository ID prefixed with repo_ (e.g., repo_12345). For folders, use the numeric folder ID. If it is not provided, the folder will be created in the root of the user's folder manager ("My Documents"). Ignored when appFolder is set to true.

Numeric folder ID.

appFolder

boolean

When set to true, the folder is created inside the OAuth2 client's app project folder, overriding the parent field. Required when using a document.app.folder scope without a folder scope.

Responses

400

Bad Request. A team folder cannot be created within another folder or team. Invalid parent ID. Must be either a string prefixed with repo_ (for repositories) or a number. * When using a document.app.folder scope, appFolder must be set to true.

403

Forbidden if the request is not authorized to create in the specified parent folder or repository, or when using a document.app.folder scope without setting appFolder to true.

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Valid Authentication Methods

API Key Grants:

OAuth 2.0 User Token and Account Token Scopes:

201Created with a Folder resource containing information about the newly created folder.