FIfirefly-iii
rule_groups

Update existing rule group.

Update existing rule group.

put/v1/rule-groups/{id}

Request

  • Base URL
    https://demo.firefly-iii.org/api
  • URL
    https://demo.firefly-iii.org/api/v1/rule-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:123

The ID of the rule group.

Headers

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

Unique identifier associated with this request.

Request body

titlestring string
descriptionstring string nullable
orderinteger
activeboolean

Example request

{
  "title": "Default rule group",
  "description": "Description of this rule group",
  "order": 4,
  "active": true
}

Response

Updated rule group stored, result in response

Example response

{
  "data": {
    "type": "rules_group",
    "id": "2",
    "attributes": {
      "created_at": "2026-02-01T00:00:00+00:00",
      "updated_at": "2026-02-01T00:00:00+00:00",
      "title": "Default rule group",
      "description": "Description of this rule group",
      "order": 4,
      "active": true
    },
    "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.