Edit Spoken Terms collection details

Update the collection name or merge new terms into an existing term list

PATCH /v3/spoken-terms/{spoken_terms_id}

Edit Spoken Terms collection details

cURL

curl --request PATCH \
  --url https://api.deepl.com/v3/spoken-terms/{spoken_terms_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{}'

200

{
  "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"
}

Authorizations

Authorization · string · header · default: DeepL-Auth-Key · required

Authentication with Authorization header and DeepL-Auth-Key authentication scheme. Example: DeepL-Auth-Key <api-key>

Path Parameters

spoken_terms_id · string · required

A unique ID assigned to the Spoken Terms collection.

Body

application/jsonapplication/x-www-form-urlencoded

name · string

New name for the Spoken Terms collection.

Maximum string length: 1024

Example:

"Updated Technical Terms"

term_lists · object[]

Term lists to merge with existing lists.

Show child attributes

Response

200

application/json

Successfully updated Spoken Terms collection.

spoken_terms_id · string

A unique ID assigned to the Spoken Terms collection.

Example:

"def3a26b-3e84-45b3-84ae-0c0aaf3525f7"

name · string

Name of the Spoken Terms collection.

Example:

"Technical Terms"

term_lists · object[]

List of term lists contained in this collection.

Show child attributes

creation_time · string<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:

"2025-08-03T14:16:18.329Z"