ManageSpokenTerms

Replace or create a term list

Replace an existing term list for a language, or create a new one if it doesn't exist.

put/v3/spoken-terms/{spoken_terms_id}/term-lists

Request

  • Base URL
    https://api.deepl.com
  • URL
    https://api.deepl.com/v3/spoken-terms/{spoken_terms_id}/term-lists
  • Auth
    API key in header Authorization

Path parameters

spoken_terms_idstring required

A unique ID assigned to the Spoken Terms collection.

Request body

langstring required

Language code (ISO 639-1) for this term list.

entriesstring required

Newline-separated list of terms, one term per line. Maximum 300 characters total.

Terms are case-sensitive. Each term must be non-empty, must not contain C0 or C1 control characters (such as tabs or newlines within a term), and must not have leading or trailing whitespace. Duplicate terms within a list are not allowed (comparison is case-sensitive).

Example request

{
  "lang": "en",
  "entries": "DeepL\nAPI\nwebhook\nintegration"
}

Response

Successfully replaced or created term list.

langstring

Language code (ISO 639-1).

entry_countinteger

Number of terms in this list.

Example response

{
  "lang": "en",
  "entry_count": 3
}

Changes

No recorded changes to this operation across all 2 revisions of this API.