PEpennylane
DMS (GED)

Upload a file to DMS

Upload a file to DMS

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

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

Request

  • Base URL
    https://app.pennylane.com
  • URL
    https://app.pennylane.com/api/external/firm/v1/companies/{company_id}/dms/files
  • Auth
    OAuth 2
    Authorization code: https://app.pennylane.com/oauth/authorize
    Token URL: https://app.pennylane.com/oauth/oauth/token scopes: dms_files:all

Path parameters

company_idinteger required

Existing company identifier (id)

Request body multipart/form-data

filestring binary required

The file you want to upload to DMS. Allowed content types:

  • text/csv
  • text/plain
  • image/png
  • image/jpeg
  • image/tiff
  • image/bmp
  • image/gif
  • application/zip
  • application/zip-compressed
  • application/x-zip-compressed
  • application/pdf
  • application/vnd.ms-excel
  • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
  • application/msword
  • application/vnd.openxmlformats-officedocument.wordprocessingml.document
  • application/mbox
  • application/octet-stream
  • application/vnd.ms-outlook
  • application/vnd.oasis.opendocument.presentation
  • application/vnd.oasis.opendocument.spreadsheet
  • application/vnd.oasis.opendocument.text
  • application/vnd.apple.pages
  • application/vnd.apple.numbers
namestring

Name of the file. If not provided, the default value will be the uploaded file name.

parent_folder_idinteger

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

Example request

{
  "name": "File.pdf",
  "parent_folder_id": 123
}

Response

Returns the created DMS file

idinteger required

ID of the file

namestring required

Name of the file

pathstring required

Path of the file

urlstring required

URL to download the file

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "id": 124,
  "name": "file.pdf",
  "path": "/path/to/file.pdf",
  "parent_folder": {
    "id": 234
  },
  "url": "https://example.com/path/to/file.pdf",
  "created_at": "2023-08-30T10:08:08.146343Z",
  "updated_at": "2023-08-30T10:08:08.146343Z"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.