LUlucid
Folders

Create Folder

Changed on

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
post/v2/folders

Request

  • Base URL
    https://api.lucid.co
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization codehttps://lucid.app/oauth2/authorize
      Token URLhttps://api.lucid.co/oauth2/token
      Scopesfolder, lucidchart.document.app.folder, lucidspark.document.app.folder, lucidscale.document.app.folder
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Request body

namestring required

Name of the folder being created.

type'folder' | 'team' 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
teamstring

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.

appFolderboolean

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.

Example request

{
  "type": "folder",
  "team": "team_99"
}

Response

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

idnumber required

Unique ID of the folder

type'folder' | 'team' 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
namestring required

Name of the folder

createdstring date-time required

Date and time of when the folder was created

trashedstring date-time nullable

Date and time of when the folder was trashed. Null when the folder is not trashed.

Example response

{
  "id": 123456789,
  "type": "folder",
  "name": "Folder Name",
  "created": "2020-06-26T16:29:37Z",
  "trashed": "2022-01-20T12:14:18Z",
  "attributes": [
    {
      "name": "Sample Label",
      "value": "Sample Value"
    }
  ],
  "repository": {
    "repositoryId": "repo_2000008"
  }
}

Changes