user_groups

Update an existing user group.

Used to update a single user group. The available fields are still limited.

put/v1/user-groups/{id}

Request

Base URL
https://demo.firefly-iii.org/api
URL
https://demo.firefly-iii.org/api/v1/user-groups/{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:1

The ID of the account.

Headers

X-Trace-Idstring uuid

Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00

Unique identifier associated with this request.

Request body

titlestring string required

A descriptive title for the user group.

primary_currency_idstring string

Use either primary_currency_id or primary_currency_code. This will set the primary currency for the user group ('financial administration').

primary_currency_codestring string

Use either primary_currency_id or primary_currency_code. This will set the primary currency for the user group ('financial administration').

Example request

{
  "title": "New user group title",
  "primary_currency_id": "1",
  "primary_currency_code": "EUR"
}

Response

Updated user group is stored, result is in the response

Example response

{
  "data": {
    "type": "user_groups",
    "id": "2",
    "attributes": {
      "created_at": "2025-11-01T00:00:00+00:00",
      "updated_at": "2025-11-01T00:00:00+00:00",
      "can_see_members": true,
      "title": "demo@firefly",
      "primary_currency_id": "12",
      "primary_currency_code": "EUR",
      "primary_currency_symbol": "$",
      "primary_currency_decimal_places": 2,
      "members": [
        {
          "user_id": "5",
          "user_email": "james@firefly-iii.org"
        }
      ]
    },
    "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.