v1

latestOpenAPI 3.0.12026-07-144840447.2 KB

DMS (GED)

Create a DMS folder

This endpoint creates a new DMS folder for the company.

ℹ️ This endpoint requires the following scope: dms_files:all

post/api/external/firm/v1/companies/{company_id}/dms/folders

Path parameters

company_idinteger required

Existing company identifier (id)

Request body

namestring required

The name of the folder

parent_folder_idinteger

ID of the parent folder. If not provided, the folder will be at root level.

Example request

{
  "name": "Folder 1",
  "parent_folder_id": 123
}

Response

Returns the created DMS folder

idinteger required

ID of the folder

namestring required

Name of the folder

pathstring required

Path of the folder

created_atstring date-time required

updated_atstring date-time required

Example response

{
  "id": 124,
  "name": "folder_name",
  "path": "/path/to/folder",
  "parent_folder": {
    "id": 234
  },
  "files": {
    "url": "https://app.pennylane.com/api/external/firm/v1/companies/1/dms/files?filter=%5B%7B%22field%22:%22parent_folder_id%22,%22operator%22:%22eq%22,%22value%22:%22124%22%7D%5D"
  },
  "created_at": "2023-08-30T10:08:08.146343Z",
  "updated_at": "2023-08-30T10:08:08.146343Z"
}