ManageMultilingualGlossaries

Edit glossary details

Changed on Nov 3, 2026

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

patch/v3/glossaries/{glossary_id}

Request

Base URL
https://api.deepl.com
URL
https://api.deepl.com/v3/glossaries/{glossary_id}
Auth
API key in header Authorization

Path parameters

glossary_idstring required

A unique ID assigned to the glossary.

Request body

namestring

A unique ID assigned to a glossary.

Example request

{
  "name": "def3a26b-3e84-45b3-84ae-0c0aaf3525f7",
  "dictionaries": [
    {
      "source_lang": "en",
      "target_lang": "de",
      "entries": "Hello\tGuten Tag",
      "entries_format": "tsv"
    }
  ]
}

Response

JSON object containing the glossary meta-information.

glossary_idstring

A unique ID assigned to a glossary.

namestring

Name associated with the glossary.

creation_timestring date-time

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

Example response

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

Changes

Nov 3, 2026c7c91cfac5c0 Revision changes
- breaking
  removed the enum value th of the request property // (media type: application/json)
- breaking
  removed the enum value th of the request property // (media type: application/x-www-form-urlencoded)
- breaking
  removed the enum value th of the request property // (media type: application/json)
- breaking
  removed the enum value th of the request property // (media type: application/x-www-form-urlencoded)
- warning
  added the new de-CH enum value to the // response property for the response status
- warning
  added the new de-DE enum value to the // response property for the response status
- warning
  added the new en-GB enum value to the // response property for the response status
- warning
  added the new en-US enum value to the // response property for the response status
- warning
  added the new es-419 enum value to the // response property for the response status
- warning
  added the new es-ES enum value to the // response property for the response status
- warning
  added the new fr-CA enum value to the // response property for the response status
- warning
  added the new fr-FR enum value to the // response property for the response status
- warning
  added the new pt-BR enum value to the // response property for the response status
- warning
  added the new pt-PT enum value to the // response property for the response status
- warning
  added the new zh-Hans enum value to the // response property for the response status
- warning
  added the new zh-Hant enum value to the // response property for the response status
- info
  added the new de-CH enum value to the request property // (media type: application/json)
- info
  added the new de-CH enum value to the request property // (media type: application/x-www-form-urlencoded)
- info
  added the new de-DE enum value to the request property // (media type: application/json)
- info
  added the new de-DE enum value to the request property // (media type: application/x-www-form-urlencoded)
- info
  added the new en-GB enum value to the request property // (media type: application/json)
- info
  added the new en-GB enum value to the request property // (media type: application/x-www-form-urlencoded)
- info
  added the new en-US enum value to the request property // (media type: application/json)
- info
  added the new en-US enum value to the request property // (media type: application/x-www-form-urlencoded)
- info
  added the new es-419 enum value to the request property // (media type: application/json)
- info
  added the new es-419 enum value to the request property // (media type: application/x-www-form-urlencoded)
- info
  added the new es-ES enum value to the request property // (media type: application/json)
- info
  added the new es-ES enum value to the request property // (media type: application/x-www-form-urlencoded)
- info
  added the new fr-CA enum value to the request property // (media type: application/json)
- info
  added the new fr-CA enum value to the request property // (media type: application/x-www-form-urlencoded)
- info
  added the new fr-FR enum value to the request property // (media type: application/json)
- info
  added the new fr-FR enum value to the request property // (media type: application/x-www-form-urlencoded)
- info
  added the new pt-BR enum value to the request property // (media type: application/json)
- info
  added the new pt-BR enum value to the request property // (media type: application/x-www-form-urlencoded)
- info
  added the new pt-PT enum value to the request property // (media type: application/json)
- info
  added the new pt-PT enum value to the request property // (media type: application/x-www-form-urlencoded)
- info
  added the new zh-Hans enum value to the request property // (media type: application/json)
- info
  added the new zh-Hans enum value to the request property // (media type: application/x-www-form-urlencoded)
- info
  added the new zh-Hant enum value to the request property // (media type: application/json)
- info
  added the new zh-Hant enum value to the request property // (media type: application/x-www-form-urlencoded)
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status
- info
  added the media type application/json for the response with the status
- info
  removed the th enum value from the // response property for the response status
- info
  removed the th enum value from the // response property for the response status

Operation history