Update a category

PATCH/v1/sites/{siteId}/categories/{code}

Renames a category, or retires it or brings it back. Only the fields sent change. A category is never deleted: retire it with active false.

Needs Catalogue: writeChanges live data

Path

• siteIdrequired

  The site, from GET /v1/sites.

  string

• coderequired

  The record's code.

  string

Headers

• Authorizationrequired

  An API key from Automation > Access in the Dnero portal, sent as Authorization: Bearer <key>.

  string

Body

• active

  False to retire the category, true to bring it back. A retired category is kept, so history and reports that use it are unaffected.

  boolean

• name

  A new name.

  string · 1–200 characters

Responses

• 200OK
• 400Bad Requestbad_requestinvalid_cursoridempotency_key_required
• 401Unauthorizedmissing_keyinvalid_keykey_expired+1 more
• 403Forbiddenkey_revokedassistant_keykey_without_access+7 more
• 404Not Foundsite_not_foundnot_found
• 409Conflictidempotency_key_reusedrequest_in_progress
• 422Unprocessable Entityinvalid_requestnot_a_modifier_group
• 429Too Many Requestsrate_limited
• 500Internal Server Errorserver_error
• 502Bad Gatewayupstream_unavailable

200 OK

• activerequired

  False for a retired category, which is listed only with includeInactive.

  boolean

• coderequired

  The category's code, the same at every site that has it.

  string

• namerequired

  The category's name.

  string

• orderrequired

  Where the category sits among the site's others, lowest first.

  integer

• defaultCourseCode

  The course a product in this category goes to the kitchen with, unless the product says otherwise.

  string

• updatedAt

  When the category last changed. Absent for one that has not changed since this was recorded.

  string · date-time

curlJavaScriptPython

curl -X PATCH "https://api.dev.dnerohq.com/v1/sites/9a3c74c2-741e-48c3-ad9e-b137ec1c7243/categories/7b3e9c14-2a6f-4d08-8b5e-c1f4a7d2e936" \
  -H "Authorization: Bearer $DNERO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "active": false,
  "name": "Hot drinks"
}'

const response = await fetch('https://api.dev.dnerohq.com/v1/sites/9a3c74c2-741e-48c3-ad9e-b137ec1c7243/categories/7b3e9c14-2a6f-4d08-8b5e-c1f4a7d2e936', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.DNERO_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "active": false,
    "name": "Hot drinks"
  }),
})
const data = await response.json()

import os
import requests

response = requests.patch(
    "https://api.dev.dnerohq.com/v1/sites/9a3c74c2-741e-48c3-ad9e-b137ec1c7243/categories/7b3e9c14-2a6f-4d08-8b5e-c1f4a7d2e936",
    headers={"Authorization": f"Bearer {os.environ['DNERO_API_KEY']}"},
    json={
      "active": False,
      "name": "Hot drinks"
    },
)
data = response.json()

200OKapplication/json

{
  "active": true,
  "code": "a1f0c5e2-7d3b-4c8e-9f21-6b0d4e7a9c13",
  "defaultCourseCode": "5c2e8a41-0b7f-4d6a-8e93-1f4c7b2d9a60",
  "name": "Coffee",
  "order": 3,
  "updatedAt": "2026-10-20T03:15:00Z"
}

400Bad Requestapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#bad_request",
  "title": "Bad Request",
  "status": 400,
  "detail": "The request could not be read, for example malformed JSON.",
  "code": "bad_request"
}

401Unauthorizedapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#missing_key",
  "title": "Unauthorized",
  "status": 401,
  "detail": "No API key was sent.",
  "code": "missing_key"
}

403Forbiddenapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#key_revoked",
  "title": "Forbidden",
  "status": 403,
  "detail": "The key was revoked or switched off in the Dnero portal.",
  "code": "key_revoked"
}

404Not Foundapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#site_not_found",
  "title": "Not Found",
  "status": 404,
  "detail": "The key does not reach that site, or there is no such site.",
  "code": "site_not_found"
}

409Conflictapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#idempotency_key_reused",
  "title": "Conflict",
  "status": 409,
  "detail": "This `Idempotency-Key` was already used for a different request.",
  "code": "idempotency_key_reused"
}

422Unprocessable Entityapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#invalid_request",
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "The request was read but is not valid.",
  "code": "invalid_request"
}

429Too Many Requestsapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#rate_limited",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The key has used its requests for this minute.",
  "code": "rate_limited"
}

500Internal Server Errorapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#server_error",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Something went wrong on Dnero's side. It has been logged.",
  "code": "server_error"
}

502Bad Gatewayapplication/problem+json

{
  "type": "https://developers.dnerohq.com/guides/errors/#upstream_unavailable",
  "title": "Bad Gateway",
  "status": 502,
  "detail": "Something Dnero depends on did not answer in time.",
  "code": "upstream_unavailable"
}

Examples use this site's API host. Keep the key in $DNERO_API_KEY; never paste it into code.