FIfirefly-iii
preferences

Store a new preference for this user.

This endpoint creates a new preference. The name and data are free-format, and entirely up to you. If the preference is not used in Firefly III itself it may not be configurable through the user interface, but you can use this endpoint to persist custom data for your own app.

post/v1/preferences

Request

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

Headers

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

Unique identifier associated with this request.

Request body

created_atstring date-time
updated_atstring date-time
namestring string required

Example request

{
  "created_at": "2025-11-01T00:00:00+00:00",
  "updated_at": "2025-11-01T00:00:00+00:00",
  "name": "currencyPreference",
  "data": [
    "EUR"
  ]
}

Response

New account stored, result in response.

Example response

{
  "data": {
    "type": "preferences",
    "id": "2",
    "attributes": {
      "created_at": "2025-11-01T00:00:00+00:00",
      "updated_at": "2025-11-01T00:00:00+00:00",
      "name": "currencyPreference",
      "data": [
        "EUR"
      ]
    }
  }
}

Changes

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