attachments

Store a new attachment.

Creates a new attachment. The data required can be submitted as a JSON body or as a list of parameters. You cannot use this endpoint to upload the actual file data (see below). This endpoint only creates the attachment object.

post/v1/attachments

Headers

X-Trace-Idstring uuid
Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00

Unique identifier associated with this request.

Request body

filenamestring string required
attachable_type'Account' | 'Budget' | 'Bill' | 'TransactionJournal' | 'PiggyBank' | 'Tag' string required

The object class to which the attachment must be linked.

attachable_idstring string required

ID of the model this attachment is linked to.

titlestring string
notesstring string nullable

Example request

{
  "filename": "file.pdf",
  "attachable_type": "Bill",
  "attachable_id": "134",
  "title": "Some PDF file",
  "notes": "Some notes"
}

Response

New attachment stored, result in response.

Changes

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