SMsmartling
Blocklist API

Create blocklist term

Changed on

Create blocklist term endpoint.

post/glossary-api/v3/accounts/{accountUid}/blocklists/{blocklistUid}/terms

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.

blocklistUidstring uuid required

Unique identifier of the blocklist.

Request body

termstring required

Blocklist term. Max term length is equal to 250 characters.

notestring

Notes / description of the term. Max note length is equal to 1500 characters.

caseSensitiveboolean

Term caseSensitive.

exactMatchboolean

Term exactMatch.

variantsstring[]

Term synonyms/variations. Max length of single variation entry is 250 characters. Max amount of variations in current array is 50.

preferredTermsstring[]

Possible terms to be used instead of blocked. Max length of single variation entry is 250 characters. Max amount of variations in current array is 50.

localeIdsLocaleId[]

Associated locale identifiers.

Example request

{
  "term": "some term to be blocked",
  "variants": [
    "en synonym to the term"
  ],
  "preferredTerms": [
    "some preferred term instead of current"
  ],
  "localeIds": [
    "uk-UA",
    "en"
  ]
}

Response

Example response

{
  "response": {
    "data": {
      "termUid": "bac90990-4be1-4570-81da-b719cddd541#",
      "blocklistUid": "aad90990-4be1-4570-81da-b719cddd8152",
      "variants": [
        "en variation of the original term"
      ],
      "preferredTerms": [
        "suggested term 1",
        "suggested term 2"
      ],
      "localeIds": [
        "en",
        "uk-UA"
      ],
      "createdByUserUid": "99b0662fbae1",
      "modifiedByUserUid": "99b0662fbae1",
      "createdDate": "2026-01-15T10:00:00Z",
      "modifiedDate": "2026-01-15T10:00:00Z"
    }
  }
}

Changes

  • 0da6569bfcb7Revision changes
    • 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 250

    • warning

      the / request property's maxLength was set to 250

    • warning

      removed the request property

    • 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

  • 2cd7a8215799Revision changes
    • info

      endpoint added