Folders

Create Folder

Creates a new folder.

post/v1/folders

Request

  • Base URL: https://api.lucid.co
  • URL: https://api.lucid.co/v1/folders
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://lucid.app/oauth2/authorize, token URL https://api.lucid.co/oauth2/token, scopes: folder, lucidchart.document.app.folder, lucidspark.document.app.folder, lucidscale.document.app.folder)

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
appFolderboolean

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.

Example request

{
  "type": "folder"
}

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

parentnumber nullable

ID of the parent folder.

createdstring date-time required

Date and time of when the folder was created

trashedstring date-time

Date and time of when the folder was trashed

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.