Notes

Upload Note Attachment

This endpoint can be used to upload a file attachment to a note. You can either send the file in a multipart/form-data request (i.e. a regular "file upload" in HTML) or a JSON request with the file encoded in base64.

Limitations:

Maximum file size: 5MB

post/notes/{noteId}/attachments

Request

Base URL
https://api.upflow.io/v1
Auth
API key in header X-Api-Key and API key in header X-Api-Secret

Request body

fileNamestring required

The name of the file.

datastring byte required

Base64 encoded string for the file. Mandatory when using application/json.

Example request

{
  "data": "JVBERi0xLjYNJeLjz9MNCjE5IDAgb2JqDTw8L0Zp...DSUlRU9GDQ=="
}

Response

Attachment created successfully.

idstring uuid required

The Attachment ID.

mimeTypestring required

The MIME type of the attached file.

fileNamestring required

The name of the attached file.

createdAtstring date-time required

The date at which the attachment was created (ISO 8601 format).

fileUrlstring uri required

The URL to download the attached file. Valid for 10 hours.

Example response

{
  "id": "00a70b35-2be3-4c43-aefb-397190134655",
  "mimeType": "image/png",
  "fileName": "document.pdf",
  "createdAt": "2015-05-05T12:30:00Z",
  "fileUrl": "https://example.com/files/document.pdf"
}

Changes

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