---
title: "Update a recurring definition -- either a bare {active} toggle, or the full edit form (both hit this route)"
method: PATCH
path: "/groups/{groupId}/finance/recurring/{recurringId}"
tags: ["Legacy (v1-compat)"]
---

# Update a recurring definition -- either a bare {active} toggle, or the full edit form (both hit this route)

`PATCH /groups/{groupId}/finance/recurring/{recurringId}`

## Request

- Base URL: `https://whatareyoudo.ing/api/v1`
- URL: `https://whatareyoudo.ing/api/v1/groups/{groupId}/finance/recurring/{recurringId}`
- Auth: HTTP bearer

## Path parameters

- `groupId` string, uuid, required
- `recurringId` string, uuid, required

## Request body

- union
  - object
    - `active` boolean, required
  - object
    - `name` string, required
    - `type` 'income' | 'expense' | 'transfer', required
    - `amount` number, required
    - `amountMinor` string: issue #63: exact alternative to amount -- wins when present
    - `nextRun` string, required
    - `interval` 'day' | 'week' | 'month' | 'year'
    - `intervalCount` integer
    - `sourceAssetId` string, uuid, nullable
    - `destAssetId` string, uuid, nullable
    - `categoryId` string, uuid, nullable
    - `payee` string, nullable
    - `description` string
    - `active` boolean

## Response `200`

OK

- CompatRecurringDefinition
  - `id` string, uuid, required
  - `name` string, required
  - `type` 'income' | 'expense' | 'transfer', required
  - `amount` number, required
  - `amount_minor` string, required: issue #63: exact integer minor-units mirror of amount
  - `currency` string, required: What amount is in: the accounts' currency (ISO 4217).
  - `source_asset_id` string, uuid, nullable, required
  - `dest_asset_id` string, uuid, nullable, required
  - `category_id` string, uuid, nullable, required
  - `payee` string, nullable, required
  - `description` string, required
  - `interval` 'day' | 'week' | 'month' | 'year', required
  - `interval_count` integer, required
  - `next_run` string, required
  - `active` boolean, required
  - `can_edit` boolean: Whether the caller may change or remove it: its creator, or the group's owner/admin (never an admin of a system group). Present on list responses.

## Other responses

- `404`: Not found

---

[API](https://skmtc.dev/whatareyoudo/apis/whatcha-api.md) · [All operations](https://skmtc.dev/whatareyoudo/apis/whatcha-api/llms.txt) · [OpenAPI document](https://skmtc.dev/whatareyoudo/apis/whatcha-api/revisions/48dd8a54abea?raw)