Update a category

A patch: omitted fields are left alone.

Renaming retags every product that carried the old label, because the label is the join key rather than an ID.

Errors

404 category_not_found — unknown ID, or one belonging to another tenant.
409 category_name_taken — the new label already exists.
409 preset_category_immutable — a built-in category can’t be edited.

PATCH/api/v1/categories/{id}

Authorization

AuthorizationBearer token (bloomcount_...) · headerrequired

Path parameters

idstringrequired

Request body

requiredapplication/json

namestring

colorstring

#RRGGBB, case-insensitive.

Responses

200Updated

categoryIdstringrequired

namestringrequired

The label a product's category is matched against.

colorstringrequired

isPresetbooleanrequired

Preset categories ship with the account and can't be deleted.

401Missing or invalid API key, or revoked / expired.

errorstringrequired

403Authenticated, but the key lacks the required scope or the tenant has no API access.

errorstringrequired

404The requested resource doesn't exist or belongs to a different tenant.

errorstringrequired

409The request is well formed, but it conflicts with the current state: a name already taken, a row the app protects (the hidden Default supplier, a preset colour or category), or a staff member who has an account.

errorstringrequired

422Request body or arguments failed validation.

errorstringrequired

429Per-minute rate limit (60/min) or per-month cap exceeded.

errorstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (bloomcount_...)Remember on this deviceInclude my values in samples

Parameters

idpath*

Bodyapplication/json

namestringcolorstring#RRGGBB, case-insensitive.

Request

curl -X PATCH "https://app.bloomcount.com/api/v1/categories/cat_n3q8w5y0m2k7r4t9v1x6z3b8" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Cut Foliage"
}'

const response = await fetch("https://app.bloomcount.com/api/v1/categories/cat_n3q8w5y0m2k7r4t9v1x6z3b8", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"Cut Foliage\"\n}"
});

import requests

response = requests.patch(
    "https://app.bloomcount.com/api/v1/categories/cat_n3q8w5y0m2k7r4t9v1x6z3b8",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"Cut Foliage\"\n}",
)

Response

{
  "categoryId": "cat_n3q8w5y0m2k7r4t9v1x6z3b8",
  "name": "Cut Foliage",
  "color": null,
  "isPreset": false
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}