DEdeepl
ManageSpokenTerms

Edit Spoken Terms collection details

Update the name of a Spoken Terms collection or merge new entries into an existing term list.

patch/v3/spoken-terms/{spoken_terms_id}

Request

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

Path parameters

spoken_terms_idstring required

A unique ID assigned to the Spoken Terms collection.

Request body

namestring

New name for the Spoken Terms collection.

Example request

{
  "name": "Updated Technical Terms",
  "term_lists": [
    {
      "lang": "en",
      "entries": "DeepL\nAPI\nwebhook"
    }
  ]
}

Response

Successfully updated Spoken Terms collection.

spoken_terms_idstring

A unique ID assigned to the Spoken Terms collection.

namestring

Name of the Spoken Terms collection.

creation_timestring date-time

The creation time of the Spoken Terms collection in ISO 8601-1:2019 format (e.g.: 2025-08-03T14:16:18.329Z).

Example response

{
  "spoken_terms_id": "def3a26b-3e84-45b3-84ae-0c0aaf3525f7",
  "name": "Technical Terms",
  "term_lists": [
    {
      "lang": "en",
      "entry_count": 3
    }
  ],
  "creation_time": "2025-08-03T14:16:18.329Z"
}

Changes

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