BizKitHub
DocsAPI ReferenceGlossary/bff/glossary/save
postGlossaryAdmin BFF

/bff/glossary/save

Upserts the term identified by id (external id). Body carries the term data for one or more locales; each locale replaces its own definitions / aliases / cross references when the arrays are provided.

GlossarypostBffGlossarySave

Parameters

JSON body

Request body

application/json
idstringOptional
codestring | nullOptional
One of 2:
Variant 1
string
Variant 2
null
categoryIdstring | nullOptional
One of 2:
Variant 1
string
Variant 2
null
visibility"public" | "private"Required
isStarbooleanOptional
publishedDatestringOptional
localesobject[]Required
Each array item:
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-oxendict → en-GB → en (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: 2–35
Examplescsenen-GBpt-BRzh-Hans
termstringRequired
Length: 1–∞
abbreviationstring | nullOptional
One of 2:
Variant 1
string
Variant 2
null
notesstring | nullOptional
One of 2:
Variant 1
string
Variant 2
null
metaTitlestring | nullOptional
One of 2:
Variant 1
string
Variant 2
null
metaDescriptionstring | nullOptional
One of 2:
Variant 1
string
Variant 2
null
definitionsobject[]Optional
Each array item:
textstringRequired
Length: 1–∞
sourcestring | nullOptional
One of 2:
Variant 1
string
Variant 2
null
aliasesstring[]Optional
crossReferencesstring[]Optional

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/save

post
curl -X POST "https://api.bizkithub.com/bff/glossary/save" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "id": "example_id",
  "isStar": false,
  "publishedDate": "example_publishedDate",
  "locales": [
    {
      "locale": "cs",
      "term": "example_term",
      "definitions": [
        {
          "text": "example_text"
        }
      ],
      "aliases": [
        "string"
      ],
      "crossReferences": [
        "string"
      ]
    }
  ]
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key