Partially update an item category

PATCH

/v1/item-categories/{id}

Applies a partial update to an item category by its ID. Only the fields included in the request body are updated; omitted fields retain their existing values. ChildTreeLevel, FullName, and QboID are computed/managed server-side.

Required scope: item-categories:write

Request

Authorization

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Category updated successfully

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

🟠409

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://dev.api.fieldedge.com/open-api/v1/item-categories/' \
--header 'Content-Type: application/json' \
--data '{
    "name": "HVAC Updated",
    "active": true,
    "imageUrl": "https://cdn.example.com/categories/hvac.png",
    "parentId": "00000000-0000-0000-0000-000000000000",
    "flatRateMatch": "EXT-001"
}'

Response Example

200 - Sample response returned after updating an item category

{
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "HVAC Updated",
    "active": true,
    "imageUrl": "https://cdn.example.com/categories/hvac.png",
    "parent": "00000000-0000-0000-0000-000000000000",
    "childTreeLevel": 0,
    "qboId": "QB-12345"
}

Modified at 2026-08-27 11:27:54

Retrieve item category by id.

Retrieve list of sales tax codes