Skip to main content
Version: 0.1.21 (Current)

update_category_group_settings

Type: mutation

Updates a category group's settings including rollover configuration.

Signature

async def update_category_group_settings(
group_id: str,
name: str = None,
budget_variability: str = None,
group_level_budgeting_enabled: bool = None,
rollover_enabled: bool = None,
rollover_start_month: str = None,
rollover_starting_balance: float = None,
rollover_type: str = None
) -> Dict[str, Any]

Parameters

ParameterTypeRequiredDescription
group_idstrYesThe ID of the category group to update
namestrNoOptional new name for the group
budget_variabilitystrNoOptional budget type - "fixed" or "flexible"
group_level_budgeting_enabledboolNoOptional - whether budgets are set at group level
rollover_enabledboolNoOptional - whether to enable/disable rollover
rollover_start_monthstrNoOptional rollover start month (YYYY-MM-DD format)
rollover_starting_balancefloatNoOptional starting balance for rollover
rollover_typestrNoOptional rollover type (e.g., "monthly")

Returns

Dict with the updateCategoryGroup result

Example

from monarchmoney import MonarchMoney

mm = MonarchMoney()
await mm.login(email, password)

result = await mm.update_category_group_settings("example_group_id")
print(result)

GraphQL Operation

Operation Name: Common_UpdateCategoryGroup

GraphQL Query

mutation Common_UpdateCategoryGroup($input: UpdateCategoryGroupInput!) {
updateCategoryGroup(input: $input) {
categoryGroup {
id
name
order
type
color
groupLevelBudgetingEnabled
budgetVariability
rolloverPeriod {
id
startMonth
endMonth
startingBalance
__typename
}
__typename
}
__typename
}
}

Try It Out

To test this API method locally:

  1. Install the package: pip install monarchmoney
  2. Create a Python script with the example code above
  3. Replace email and password with your Monarch Money credentials
  4. Run the script

See the Authentication Guide for details on logging in.