Glossary API

Create glossary endpoint.

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

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.

Request body

glossaryNamestring required

Name of the glossary, unique within the account. Character limit is equal to 170 characters.

descriptionstring

Description of the glossary. Character limit is equal to 250 characters.

verificationModeboolean

Verification mode.

localeIdsLocaleId[] required

Supported locale ids. Must not be empty; each locale must be a supported Smartling locale.

Example request

{
  "glossaryName": "My new glossary",
  "description": "Glossary created for common terms in scope of 'my-project'",
  "localeIds": [
    "uk-UA",
    "en",
    "pt",
    "pt-BR"
  ],
  "fallbackLocales": [
    {
      "fallbackLocaleId": "fr-FR",
      "localeIds": [
        "en-US",
        "en-ES"
      ]
    }
  ]
}

Response

Example response

{
  "response": {
    "data": {
      "glossaryUid": "58966072-6569-4c22-930c-de906b7fb18d",
      "accountUid": "56a0b220",
      "glossaryName": "CF-enabled-glossary-V2",
      "createdByUserUid": "99b0662fbae1",
      "modifiedByUserUid": "99b0662fbae1",
      "createdDate": "2026-01-15T10:00:00Z",
      "modifiedDate": "2026-01-15T10:00:00Z",
      "localeIds": [
        "en",
        "en-US",
        "hi-IN",
        "pl-PL",
        "uk-UA"
      ],
      "fallbackLocales": [
        {
          "fallbackLocaleId": "fr-FR",
          "localeIds": [
            "en-US"
          ]
        }
      ]
    }
  }
}

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 250

    • warning

      the request property's maxLength was set to 170

    • 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