FYfynk
File Upload Helpers

Create document attachment upload URL

Changed on

<small>Requires an API token with the Document Manager role.</small>

Generates a presigned URL for securely uploading a file to cloud storage. The uploaded file can then be added to a document as an attachment via the Add an attachment to a document endpoint.

The returned URL expires after a limited time and should be used immediately for upload. Upload the file with a POST request to the returned URL, sending the provided fields as form fields in the request body, followed by the file contents in a file field.

The request accepts a content_type string matching one of the rows below.

File typecontent_type
PDFapplication/pdf
MS Word (.doc)application/msword
MS Word (.docx)application/vnd.openxmlformats-officedocument.wordprocessingml.document
Excel (.xls)application/vnd.ms-excel
Excel (.xlsx)application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
PowerPoint (.ppt)application/vnd.ms-powerpoint
PowerPoint (.pptx)application/vnd.openxmlformats-officedocument.presentationml.presentation
XMLapplication/xml
EMLmessage/rfc822
CSVtext/csv
Plain text (.txt)text/plain
Imagesimage/jpeg, image/png, image/webp, image/gif

For a complete guide with examples, see How to add an attachment to a document.

post/file-uploads/document-attachment

Request

  • Base URL
    https://app.fynk.com/v1/api
  • URL
    https://app.fynk.com/v1/api/file-uploads/document-attachment
  • Auth
    HTTP bearer

Request body

content_type'application/pdf' | 'application/msword' | 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' | 'application/xml' | 'application/vnd.ms-excel' | 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' | 'application/vnd.ms-powerpoint' | 'application/vnd.openxmlformats-officedocument.presentationml.presentation' | 'text/csv' | 'text/plain' | 'message/rfc822' | 'image/jpeg' | 'image/png' | 'image/webp' | 'image/gif' required

The MIME type string of the file being uploaded.

Example request

{
  "content_type": "application/pdf"
}

Response

SignedUploadUrlResource

Example response

{
  "data": {
    "uuid": "ab2665c1-9a7c-4230-a431-21682eb302aa",
    "url": "https://s3.eu-central-1.amazonaws.com/...",
    "method": "POST",
    "expires_at": "2019-08-24T14:15:22Z"
  }
}

Changes