SaaSFlow
DevelopersAPIReferencecategories

Update category

Update a category's name, emoji, plTypes, or order. Only the fields you send change. Narrowing plTypes does not rewrite transactions already categorized…

Authentication

Checking whether you're signed in…
PUT
/companies/{companyId}/categories/{categoryId}

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
categoryId*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/categories/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",  "name": "string",  "emoji": "string",  "plTypes": [    "revenue"  ],  "system": true,  "systemKey": "string",  "order": -8388608,  "createdTime": "2019-08-24T14:15:22Z",  "createdUserId": "string",  "lastUpdatedTime": "2019-08-24T14:15:22Z",  "lastUpdatedUserId": "string"}

Delete category

Delete a category. Refused with 409 while any transaction is still categorized under it or any planned transaction still uses it, and with 400 for system…

Batch delete

Delete several categories at once. All or nothing: if any id in the list is a system category, or still has transactions or planned transactions attached…