SIsimplelocalize
Glossary

Create glossary entry

Changed on

Creates a glossary entry with translations of a term in one or more target languages.

  • sourceLanguage and every targets[].targetLanguage must be existing language keys in the project
  • if an entry with the same sourceText already exists, its translations are updated instead of duplicated
  • caseSensitive makes quality checks match the term and its translations exactly as written, including capitalization; omit it to keep the current value
  • targets[].forms lists alternative forms of a translation (plural, cases) accepted by quality checks; omit it to keep the current forms
  • glossary is not available in the Community plan
post/api/v1/glossary

Request

Headers

X-SimpleLocalize-Tokenstring required

Request body

sourceTextstring required

Term in the source language

sourceLanguagestring required

Source language key, must exist in the project

caseSensitiveboolean

When true, quality checks match the term and its translations exactly as written, including capitalization. Omitted: keeps the current value for an existing term, false for a new one

Example request

{
  "sourceText": "Sign in",
  "sourceLanguage": "en",
  "targets": [
    {
      "targetLanguage": "pl",
      "targetText": "Zaloguj się",
      "forms": [
        "Zalogowanie się"
      ]
    }
  ]
}

Response

OK

msgstring
statusinteger

Example response

{
  "data": {
    "sourceText": "Sign in",
    "sourceLanguage": "en",
    "targets": [
      {
        "targetLanguage": "pl",
        "targetText": "Zaloguj się",
        "forms": [
          "Zalogowanie się"
        ]
      }
    ]
  }
}

Changes