FireFly III icon

FireFly III

Read, update, write and delete data using the powerful FireFly III API

Actions89

Object Groups API → Update Object Group

AI-generated

Overview

This node operation updates an existing Object Group in the FireFly III system. It allows users to modify the title and other optional fields such as the display order of the object group. This is useful for managing and organizing groups of objects like bills or piggy banks within FireFly III, enabling better categorization and display customization.

Use Case Examples

  1. Updating the title of an object group to better reflect its purpose.
  2. Changing the display order of an object group to prioritize its visibility in the user interface.

Properties

Name Meaning
X-Trace-ID A unique UUID identifier for the request, used for debugging and tracing.
Object Group ID The ID of the object group to update.
Title The new title or name of the object group.
Update Fields Additional fields to update for the object group, such as the display order.

Output

JSON

  • id - The unique identifier of the updated object group.
  • title - The updated title of the object group.
  • order - The updated display order of the object group.
  • created_at - Timestamp when the object group was created.
  • updated_at - Timestamp when the object group was last updated.

Dependencies

  • FireFly III API
  • An API key credential for authentication

Troubleshooting

  • Ensure the Object Group ID is valid and exists in the FireFly III system to avoid 'not found' errors.
  • Verify that the API key credential is correctly configured and has sufficient permissions to update object groups.
  • Check that the title field is not empty as it is required for the update operation.
  • If the API returns an error, review the X-Trace-ID for debugging and tracing the request in FireFly III logs.

Links

Discussion