Manual
CLI
API
Log in Get started free

Create a glossary term

Adds a term. It starts with the status `review`.

Adds a term. It starts with the status review.

HTTP
POST /glossary

Access: Session token only. API keys get 403 with insufficient_scope.

Request body #

JSON.

FieldTypeRequiredDescription
namestringyesThe term. At most 120 characters.
posstringnoPart of speech. At most 40 characters. Default Noun.
definitionstringnoAt most 2000 characters.
projectIdslist of stringnoProjects the term applies to. Ids of projects you cannot see are ignored.
JSON
{ "name": "checkout", "definition": "The step where a customer pays." }

Response 201 #

The term.

JSON
{
  "id": "0197a3cc-a3b9-7aaa-9d00-5b9ebc6a832a",
  "name": "checkout",
  "pos": "Noun",
  "status": "approved",
  "definition": "The step where a customer pays.",
  "example": "Go to checkout.",
  "forbidden": ["cash register"],
  "related": ["cart"],
  "translations": [
    { "code": "de-de", "value": "Kasse", "state": "approved", "annotation": null, "conflict": null }
  ],
  "projectIds": ["0197a3c6-4d53-7a44-87fb-9b3e5c0a2d64"],
  "addedBy": "Ada Lovelace",
  "addedMinutes": 4320,
  "editedBy": "Ada Lovelace",
  "editedMinutes": 60
}

Response fields #

FieldTypeDescription
idstringThe id of the term.
namestringThe term.
posstringPart of speech, free text. Default Noun.
statusstringapproved, review (default for a new term) or notranslate.
definitionstringThe definition.
examplestringAn example.
forbiddenlist of stringWords that must not be used.
relatedlist of stringRelated terms.
translationslist of objectOne per language: code, value, state (approved, pending, missing, conflict or unchanged), annotation and conflict.
projectIdslist of stringProjects the term applies to.
addedBystring or nullWho added it.
addedMinutesinteger or nullMinutes since it was added.
editedBystring or nullWho last changed it.
editedMinutesinteger or nullMinutes since it changed.

Errors #

StatuserrorWhen
401unauthenticatedThe token is missing or not valid.
409conflictThe glossary already has this term.
422invalid_requestname is empty or too long, or another text is too long.
429rate_limitedToo many requests, see Rate limiting.

See Errors for the error format.