Create Folder

post

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

Creates a new folder.

Valid Authentication Methods

API Key Grants:

FolderEdit

OAuth 2.0 User Token Scopes:

folder
lucidchart.document.app.folder
lucidspark.document.app.folder
lucidscale.document.app.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, repository, or Team to create the new folder in. For repositories, use the repository ID prefixed with repo_ (e.g., repo_12345). For Teams, use the Team ID prefixed with team_ (e.g., team_99), which creates the folder in the root of that Team. 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. With only app-folder scope, an explicit parent must be inside the authenticated user's app project.

Numeric folder ID.

team

string

deprecated

Deprecated. Team whose root should contain the new folder, as an ID prefixed with team_; the legacy numeric team ID is also accepted. Use parent with a team_-prefixed Team ID instead. Cannot be provided together with a Team parent.

appFolder

boolean

When set to true, the folder is created inside the OAuth2 client's app project folder, overriding the parent field. With only a document.app.folder scope, omit this field or set it to false and supply a parent inside the app project to create a nested folder.

Responses

400

Bad Request. A team folder cannot be created within another folder or team. Both a Team parent and a team were provided. Invalid parent ID. Must be a number (for folders), a string prefixed with repo_ (for repositories), or a string prefixed with team_ (for Teams). When using a document.app.folder scope, appFolder cannot be false without a parent, a team cannot be supplied, the folder type must be folder, and an explicit parent must be a folder ID rather than a repository.

403

Forbidden if the request is not authorized to create in the specified parent folder, repository, or Team, if the specified Team does not exist, or when using a document.app.folder scope without either appFolder: true or a parent inside the app project.

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.