Edit glossary details

Edit glossary details, such as name or a dictionary for a source and target language.

PATCH /v3/glossaries/{glossary_id}

Edit glossary details

cURL

curl --request PATCH \
  --url https://api.deepl.com/v3/glossaries/{glossary_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "def3a26b-3e84-45b3-84ae-0c0aaf3525f7",
  "dictionaries": [
    {
      "source_lang": "en",
      "target_lang": "de",
      "entries": "Hello\tGuten Tag",
      "entries_format": "tsv"
    }
  ]
}
'

200

{
  "glossary_id": "def3a26b-3e84-45b3-84ae-0c0aaf3525f7",
  "name": "My Glossary",
  "dictionaries": [
    {
      "source_lang": "EN",
      "target_lang": "DE",
      "creation_time": "2021-08-03T14:16:18.329Z",
      "entry_count": 1
    },
    {
      "source_lang": "DE",
      "target_lang": "EN",
      "creation_time": "2021-08-03T14:16:18.429Z",
      "entry_count": 2
    }
  ]
}

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

glossary_id · string · required

A unique ID assigned to the glossary.

Body

application/jsonapplication/x-www-form-urlencoded

name · string

A unique ID assigned to a glossary.

Example:

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

dictionaries · object[]

Dictionaries to edit the glossary with. Currently only supports 0 or 1 dictionaries in the array.

Show child attributes

Response

200

application/json

JSON object containing the glossary meta-information.

glossary_id · string

A unique ID assigned to a glossary.

Example:

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

name · string

Name associated with the glossary.

dictionaries · object[]

List of dictionaries contained in this glossary. Each dictionary contains a source and target language, as well as pairs of source and target entries.

Show child attributes

creation_time · string<date-time>

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