Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Glossary Terms

Create a term

Create a new term in a term base (previously: glossary).

post/accounts/{account_id}/glossaries/{glossary_id}/terms

Path parameters

account_idstring required

Account ID

glossary_idstring required

Glossary ID

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Request body

termstring required

Glossary term

descriptionstring

Description of term

translatableboolean

Indicates whether the term should be used for all languages or can be translated

case_sensitiveboolean

Indicates whether the term is case sensitive

Example request

{
  "term": "MyCompany",
  "description": "Use this when refering to our company",
  "translatable": true,
  "case_sensitive": true
}

Response

Created

idstring
termstring
descriptionstring
translatableboolean
case_sensitiveboolean
created_atstring date-time
updated_atstring date-time

Example response

{
  "id": "abcd1234cdef1234abcd1234cdef1233",
  "term": "Save",
  "description": "This term is used on the 'Save' buttons of our website",
  "translatable": true,
  "case_sensitive": true,
  "translations": [
    {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "locale_code": "fr-FR",
      "content": "Entasser",
      "created_at": "2015-01-28T09:52:53Z",
      "updated_at": "2015-01-28T09:52:53Z"
    },
    {
      "id": "abcd1234cdef1234abcd1234cdef1235",
      "locale_code": "de-DE",
      "content": "Speichern",
      "created_at": "2015-01-28T09:52:53Z",
      "updated_at": "2015-01-28T09:52:53Z"
    }
  ],
  "created_at": "2015-01-28T09:52:53Z",
  "updated_at": "2015-01-28T09:52:53Z"
}