BizKitHub
DocsAPI ReferenceGlossary/bff/glossary/category/save
postGlossaryAdmin BFF

/bff/glossary/category/save

Create or update a glossary category

GlossarypostBffGlossaryCategorySave

Parameters

JSON body

Request body

application/json
idstringOptional
parentIdstring | nullOptional
One of 2:
Variant 1
string
Variant 2
null
activebooleanOptional
positionnumberOptional
localestringRequired

Communication locale code — controls the language of textual data (product names, descriptions, articles, storefront UI, transactional e-mails).

Preferred format: BCP 47 language tag — language[-Script][-REGION]. Use the full tag whenever the script or region matters:

  • en-GB vs. en-US (British vs. American spelling)
  • pt-PT vs. pt-BR (European vs. Brazilian Portuguese)
  • zh-Hans vs. zh-Hant (Simplified vs. Traditional Chinese)
  • sr-Latn vs. sr-Cyrl (Latin vs. Cyrillic Serbian)

Backwards-compatible fallback: the bare two-letter ISO 639-1 code (cs, en, pl, …) is accepted indefinitely — legacy clients that only send the language subtag continue to work unchanged.

Resolution algorithm (server-side): the input is resolved against the supported locale list via the [RFC 4647 Lookup] progressive-fallback strategy — trailing subtags are stripped one by one until a supported locale is found. Example: en-GB-oxendicten-GBen (matched). If no subtag combination is supported, the request is rejected.

Currently supported locales: cs, en, fr, it, pl, de, sk, sv, es, zh, ja, uk, da, hu, ro, nl, pt, fi, nb, hr. Region-specific variants (e.g. en-GB, pt-BR) are accepted and resolved to their base language when the exact variant is not registered separately.

Length: 235
Examplescsenen-GBpt-BRzh-Hans
namestringOptional
descriptionstring | nullOptional
One of 2:
Variant 1
string
Variant 2
null
metaDescriptionstring | nullOptional
One of 2:
Variant 1
string
Variant 2
null

Response schema

1 status code documented

200Success
state"ok"Required
idstringRequired

Response example

application/json
{
  "state": "ok",
  "id": "example_id"
}

Request example

POST /bff/glossary/category/save

post
curl -X POST "https://api.bizkithub.com/bff/glossary/category/save" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "id": "example_id",
  "active": false,
  "position": 0,
  "locale": "cs",
  "name": "example_name"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key