SaaSFlow
DevelopersAPIReferenceaccount_groups

Update account group

Rename an account group or archive it. Archiving hides the group in the app without touching the accounts inside it.

Authentication

Checking whether you're signed in…
PUT
/companies/{companyId}/account_groups/{accountGroupId}

Authorization

Authorization<token>

A SaaSFlow API key (format sf_…) or an OAuth bearer token. Paste only the key — the proxy adds the Bearer prefix. Create an API key in Settings → Company settings → API keys — see API keys.

In: header

Path Parameters

companyId*string
Length1 <= length
accountGroupId*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X PUT "https://example.com/companies/string/account_groups/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",  "name": "string",  "archived": true,  "order": -8388608,  "createdTime": "2019-08-24T14:15:22Z",  "createdUserId": "string",  "lastUpdatedTime": "2019-08-24T14:15:22Z",  "lastUpdatedUserId": "string"}

Delete account group

Delete an account group. Move every account out of the group first (PUT /accounts/{accountId}/change_group), otherwise the delete fails on the foreign key…

List accounts

List a company's accounts (bank, cash, credit card, loan, transit, other) with the integration managing each one, where there is one.