Glossary API

Create glossary entry

Changed on

Create glossary entry endpoint.

post/glossary-api/v3/accounts/{accountUid}/glossaries/{glossaryUid}/entries

Request

  • Base URL
    https://api.smartling.com
  • Auth
    HTTP bearer

Path parameters

accountUidstring required

The account’s unique identifier. This can be found in the Smartling Dashboard under Account Settings > API.

glossaryUidstring uuid required

Unique identifier of the glossary.

Request body

definitionstring

Glossary entry definition. Max definition length is equal to 1500 characters.

partOfSpeech'NOUN' | 'VERB' | 'ADJECTIVE' | 'ADVERB' | 'PRONOUN' | 'PREPOSITION' | 'INTERJECTION' | 'CONJUNCTION' | 'PROPER_NOUN'

Glossary entry part of speech. Accepts both uppercase enum constants and human-readable formats (case-insensitive). Supported values:

  • NOUN / Noun
  • VERB / Verb
  • ADJECTIVE / Adjective
  • ADVERB / Adverb
  • PRONOUN / Pronoun
  • PREPOSITION / Preposition
  • INTERJECTION / Interjection
  • CONJUNCTION / Conjunction
  • PROPER_NOUN / "Proper Noun"
labelUidsstring[]

Glossary label uid to be associated.

skipMissingTranslationsboolean

When set to true, any missing translations in the request will be ignored during a glossary entry update — they will neither be deleted nor modified. If false (default), missing translations may be removed or updated to reflect the provided data.

suggestionboolean

Create the entry as a suggestion (suggestionStatus SUGGESTED) instead of a standard entry.

Example request

{
  "partOfSpeech": "NOUN",
  "labelUids": [
    "bad90990-4be1-4570-81da-b719cddd5351",
    "bad90990-4be1-4570-81da-b719cddd5355"
  ],
  "skipMissingTranslations": true,
  "translations": [
    {
      "localeId": "fr-FR",
      "term": "en term",
      "variants": [
        "en synonym to the term"
      ],
      "customFieldValues": [
        {
          "fieldUid": "c-field_1",
          "fieldValue": "field string value short text"
        }
      ]
    }
  ],
  "customFieldValues": [
    {
      "fieldUid": "c-field_1",
      "fieldValue": "field string value short text"
    }
  ]
}

Response

Example response

{
  "response": {
    "data": {
      "entryUid": "bac90990-4be1-4570-81da-b719cddd5352",
      "glossaryUid": "aad90990-4be1-4570-81da-b719cddd5352",
      "partOfSpeech": "NOUN",
      "translations": [
        {
          "localeId": "fr-FR",
          "fallbackLocaleId": "fr-FR",
          "term": "en term",
          "variants": [
            "en variation of the original term"
          ],
          "customFieldValues": [
            {
              "fieldUid": "c_field_1",
              "fieldName": "gender",
              "fieldValue": "unknown",
              "localeId": "fr-FR"
            }
          ],
          "requestTranslationStatus": {
            "localeId": "fr-FR",
            "requestDateTime": "2026-01-15T10:00:00Z",
            "requestUserUid": "99b0662fbae1"
          },
          "createdByUserUid": "99b0662fbae1",
          "modifiedByUserUid": "99b0662fbae1",
          "createdDate": "2026-01-15T10:00:00Z",
          "modifiedDate": "2026-01-15T10:00:00Z"
        }
      ],
      "customFieldValues": [
        {
          "fieldUid": "c_field_1",
          "fieldName": "gender",
          "fieldValue": "unknown"
        }
      ],
      "mtOptimizedLabel": "MT-Compatibility pending",
      "suggestionStatus": "SUGGESTED",
      "createdByUserUid": "99b0662fbae1",
      "modifiedByUserUid": "99b0662fbae1",
      "createdDate": "2026-01-15T10:00:00Z",
      "modifiedDate": "2026-01-15T10:00:00Z"
    }
  }
}

Changes

    • breaking

      the request property became required

    • breaking

      the request property's minItems was increased to 1

    • breaking

      the response's body type changed from no type to object for status

    • warning

      the request property's maxLength was set to 1500

    • warning

      the // request property's maxLength was set to 1500

    • warning

      the // request property's maxLength was set to 250

    • warning

      the /// request property's maxLength was set to 250

    • info

      added the new optional request property

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the required property to the response with the status

    • info

      endpoint added