FIfirefly-iii
attachments

Update existing attachment.

Update the meta data for an existing attachment. This endpoint does not allow you to upload or download data. For that, see below.

put/v1/attachments/{id}

Request

  • Base URL
    https://demo.firefly-iii.org/api
  • URL
    https://demo.firefly-iii.org/api/v1/attachments/{id}
  • Auth
    • OAuth 2
      Authorization code: https://demo.firefly-iii.org/oauth/authorize
      Token URL: https://demo.firefly-iii.org/oauth/token
    • or HTTP bearer

Path parameters

idstring required
Example:123

The ID of the attachment.

Headers

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

Unique identifier associated with this request.

Request body

filenamestring string
titlestring string
notesstring string nullable

Example request

{
  "filename": "file.pdf",
  "title": "Some PDF file",
  "notes": "Some notes"
}

Response

Updated attachment stored, result in response

Example response

{
  "data": {
    "type": "attachments",
    "id": "2",
    "attributes": {
      "created_at": "2025-10-01T00:00:00+00:00",
      "updated_at": "2025-10-01T00:00:00+00:00",
      "attachable_type": "Bill",
      "attachable_id": "134",
      "hash": "0c3f95f34370baa88f9fd9a671fea305",
      "filename": "file.pdf",
      "download_url": "https://demo.firefly-iii.org/api/v1/attachments/191/download",
      "upload_url": "https://demo.firefly-iii.org/api/v1/attachments/191/download",
      "title": "Some PDF file",
      "notes": "Some notes",
      "mime": "application/pdf",
      "size": 48211
    },
    "links": {
      "0": {
        "rel": "self",
        "uri": "/OBJECTS/1"
      },
      "self": "https://demo.firefly-iii.org/api/v1/OBJECTS/1"
    }
  }
}

Changes

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