Update existing tag.

PUT

https://firefly.example.com/api/v1/tags/{tag}

curl -X PUT 'https://firefly.example.com/api/v1/tags/groceries' \
  -H 'X-Trace-Id: 40c71bbb-c676-4f24-83cf-cc725d7d7a00' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "tag": "expensive",
  "date": "2026-10-01",
  "description": "Tag for expensive stuff",
  "latitude": 51.983333,
  "longitude": 5.916667,
  "zoom_level": 6
}'

const body = `{
  "tag": "expensive",
  "date": "2026-10-01",
  "description": "Tag for expensive stuff",
  "latitude": 51.983333,
  "longitude": 5.916667,
  "zoom_level": 6
}`;

const response = await fetch('https://firefly.example.com/api/v1/tags/groceries', {
  method: 'PUT',
  headers: {
    'X-Trace-Id': '40c71bbb-c676-4f24-83cf-cc725d7d7a00',
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "tag": "expensive",
  "date": "2026-10-01",
  "description": "Tag for expensive stuff",
  "latitude": 51.983333,
  "longitude": 5.916667,
  "zoom_level": 6
}'''

response = requests.put(
    'https://firefly.example.com/api/v1/tags/groceries',
    data=body.encode('utf-8'),
    headers={
        'X-Trace-Id': '40c71bbb-c676-4f24-83cf-cc725d7d7a00',
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "tag": "expensive",
  "date": "2026-10-01",
  "description": "Tag for expensive stuff",
  "latitude": 51.983333,
  "longitude": 5.916667,
  "zoom_level": 6
}

{
  "tag": "expensive",
  "date": "2026-10-01",
  "description": "Tag for expensive stuff",
  "latitude": 51.983333,
  "longitude": 5.916667,
  "zoom_level": 6
}

{
  "data": {
    "type": "tags",
    "id": "2",
    "attributes": {
      "created_at": "2026-10-01T00:00:00+00:00",
      "updated_at": "2026-10-01T00:00:00+00:00",
      "tag": "expensive",
      "date": "2026-10-01",
      "description": "Tag for expensive stuff",
      "latitude": 51.983333,
      "longitude": 5.916667,
      "zoom_level": 6
    },
    "links": {
      "0": {
        "rel": "self",
        "uri": "/OBJECTS/1"
      },
      "self": "https://demo.firefly-iii.org/api/v1/OBJECTS/1"
    }
  }
}

{
  "message": "Bad Request",
  "exception": "BadRequestHttpException"
}

{
  "message": "Unauthenticated",
  "exception": "AuthenticationException"
}

{
  "message": "Resource not found",
  "exception": "NotFoundHttpException"
}

{
  "message": "The given data was invalid.",
  "errors": {
    "email": [
      "string"
    ],
    "force": [
      "string"
    ],
    "blocked": [
      "string"
    ],
    "field": [
      "string"
    ],
    "role": [
      "string"
    ],
    "blocked_code": [
      "string"
    ],
    "name": [
      "string"
    ],
    "type": [
      "string"
    ],
    "iban": [
      "string"
    ],
    "start": [
      "string"
    ],
    "end": [
      "string"
    ],
    "date": [
      "string"
    ]
  }
}

{
  "message": "Internal Exception",
  "exception": "InternalException"
}

Body

JSON array with updated tag information. See the model for the exact specifications.

application/json,application/x-www-form-urlencodedTagModelUpdate

tagstring

The tag

Example

expensive

datestring<date> | null

The date to which the tag is applicable.

Example

2026-10-01

descriptionstring | null

Example

Tag for expensive stuff

latitudenumber<double> | null

Latitude of the tag's location, if applicable. Can be used to draw a map.

Example

51.983333

longitudenumber<double> | null

Latitude of the tag's location, if applicable. Can be used to draw a map.

Example

5.916667

zoom_levelinteger<int32> | null

Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels.

Example

Parameters

tagstringrequiredpath

Either the tag itself or the tag ID. If you use the tag itself, and it contains international (non-ASCII) characters, your mileage may vary.

Response

200OKTagSingle

Updated tag stored, result in response

Response fields application/vnd.api+json

dataTagReadrequired

Show child attributes

typestringrequired

Immutable value

Example

tags

idstringrequired

Example

attributesTagModelrequired

Show child attributes

created_atstring<date-time>read only

Example

2026-10-01T00:00:00+00:00

updated_atstring<date-time>read only

Example

2026-10-01T00:00:00+00:00

tagstringrequired

The tag

Example

expensive

datestring<date> | null

The date to which the tag is applicable.

Example

2026-10-01

descriptionstring | null

Example

Tag for expensive stuff

latitudenumber<double> | null

Latitude of the tag's location, if applicable. Can be used to draw a map.

Example

51.983333

longitudenumber<double> | null

Latitude of the tag's location, if applicable. Can be used to draw a map.

Example

5.916667

zoom_levelinteger<int32> | null

Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels.

Example

linksObjectLinkrequired

Show child attributes

0object

Show child attributes

relstring

Example

self

uristring

Example

/OBJECTS/1

selfstring<uri>

Example

https://demo.firefly-iii.org/api/v1/OBJECTS/1

400Bad RequestBadRequestResponse

Bad request

Response fields application/json

messagestring

Example

Bad Request

exceptionstring

Example

BadRequestHttpException

401UnauthorizedUnauthenticatedResponse

Unauthenticated

Response fields application/json

messagestring

Example

Unauthenticated

exceptionstring

Example

AuthenticationException

404Not FoundNotFoundResponse

Page not found

Response fields application/json

messagestring

Example

Resource not found

exceptionstring

Example

NotFoundHttpException

422Unprocessable EntityValidationErrorResponse

Validation error. The body will have the exact details.

Response fields application/json

messagestring

Example

The given data was invalid.

errorsobject

Show child attributes

emailArray<string>

forceArray<string>

blockedArray<string>

fieldArray<string>

roleArray<string>

blocked_codeArray<string>

nameArray<string>

typeArray<string>

ibanArray<string>

startArray<string>

endArray<string>

dateArray<string>

500Internal Server ErrorInternalExceptionResponse

Internal exception

Response fields application/json

messagestring

Example

Internal Exception

exceptionstring

Example

InternalException

Authorization

firefly_iii_authoauth2

OAuth2 authorization code flow. Create a client on your installation's /profile page; it authorizes at /oauth/authorize and issues tokens at /oauth/token there. The URLs below are the demo site's. How to use the API walks through it.

local_bearer_authhttp (bearer)

A Personal Access Token, sent as a bearer token. Create one on your installation under Options > Profile > OAuth > Personal Access Tokens.