v1

latestOpenAPI 3.0.12026-07-144840447.2 KB

File Attachments

Upload a file

Upload a file to attach to any resource that provides a file_attachment_id.

The maximum allowed file size is 100MB. Note that this will not upload a file into the DMS (GED).

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

post/api/external/firm/v1/companies/{company_id}/file_attachments

Path parameters

company_idinteger required

Example:1

Existing company identifier (id)

Response

Returns the created attachment

idinteger required

urlstring required

URL to the uploaded file.

filenamestring required

created_atstring date-time required

updated_atstring date-time required

Example response

{
  "url": "http://www.pennylane.com/rails/active_storage/blobs/redirect/eyJfc..==--26d6e7391dd728fae2cde59bd3fbe4dd11e20a95/Invoice42.pdf",
  "created_at": "2023-08-30T10:08:08.146343Z",
  "updated_at": "2023-08-30T10:08:08.146343Z"
}