groups

Update group

Updates group information (admin only)

put/groups/{id}

Request

  • Base URL: http://localhost:3001
  • URL: http://localhost:3001/groups/{id}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring required

Group UUID

Request body

namestring

Name of the group

descriptionstring

Description of the group

iconstring

Icon name for the group

colorstring

Hex color for the group

defaultCurrencystring

Default currency code (ISO 4217)

supportedCurrenciesstring[]

List of supported currencies

currencyOrderstring[]

Display order for currencies

Example request

{
  "name": "Weekend Trip",
  "description": "Trip expenses",
  "icon": "users",
  "color": "#3b82f6",
  "defaultCurrency": "USD",
  "supportedCurrencies": [
    "USD",
    "EUR"
  ],
  "currencyOrder": [
    "USD",
    "EUR"
  ]
}

Response

Group updated successfully

successboolean
messagestring

Example response

{
  "success": true,
  "message": "Success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.