Skip to content

Update a specific category

PUT
/categories/{id}
curl --request PUT \
--url http://localhost:8000/api/v1/categories/1 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "client_id": "example", "name": "example", "description": "example", "icon": "example", "icon_type": "example", "updated_at": "2026-04-15T12:00:00Z" }'
id
required
integer

ID of the category

Media type application/json
object
client_id

Unique identifier for your local client

string
name

Name of the category

string
description

The description of the category

string
icon

The icon of the category (file or icon string)

string
icon_type

The type of the icon (icon or emoji or image)

string
updated_at
string format: date-time
Example generated
{
"client_id": "example",
"name": "example",
"description": "example",
"icon": "example",
"icon_type": "example",
"updated_at": "2026-04-15T12:00:00Z"
}

Category updated successfully

Media type application/json
object
id

ID of the category

integer
name

Name of the category

string
description

Description of the category

string
type

Type of the category (income or expense)

string
icon

Category icon

object
id

ID of the icon

integer
path

Image of the icon

string
type

Type of icon( image or icon or emoji)

string
sync_state

Sync state

object
id

ID of the sync state

integer
syncable_id

ID of the syncable

integer
client_generated_id

ID from the client

integer
syncable_type

Syncable type

string
source
string
last_synced_at

Date last synced

string format: date-time
created_at

Date created

string format: date-time
deleted_at

Date deleted

string format: date-time
Example generated
{
"id": 1,
"name": "example",
"description": "example",
"type": "example",
"icon": {
"id": 1,
"path": "example",
"type": "example"
},
"sync_state": {
"id": 1,
"syncable_id": 1,
"client_generated_id": 1,
"syncable_type": "example",
"source": "example",
"last_synced_at": "2026-04-15T12:00:00Z",
"created_at": "2026-04-15T12:00:00Z",
"deleted_at": "2026-04-15T12:00:00Z"
}
}

Invalid input

Category not found

Internal server error