Skip to main content
PUT
Replaces or creates a dictionary in the glossary with the specified entries.

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/json

The dictionary to insert into (or overwrite in) the multilingual glossary.

source_lang
enum<string>

The language in which the source texts in the glossary are specified.

Available options:
ar,
bg,
cs,
da,
de,
el,
en,
es,
et,
fi,
fr,
he,
hu,
id,
it,
ja,
ko,
lt,
lv,
nb,
nl,
pl,
pt,
ro,
ru,
sk,
sl,
sv,
tr,
uk,
vi,
zh
Example:

"en"

target_lang
enum<string>

The language in which the target texts in the dictionary are specified. Besides the base languages, the target can be one of these variants: de-CH, de-DE, en-GB, en-US, es-419, es-ES, fr-CA, fr-FR, pt-BR, pt-PT, zh-Hans, or zh-Hant. Source languages are always base languages. The current list is returned by GET /v3/languages?resource=glossary.

A dictionary with a base target, such as de, applies when translating into that language and any of its variants. A dictionary with a variant target, such as de-CH, applies only when translating into that exact variant.

Within one glossary, each language family uses either the base language or its variants as targets, not both. For example, de-CH and de-DE can be combined, but de and de-DE cannot. Adding a dictionary that breaks this rule returns a 400 error.

Available options:
ar,
bg,
cs,
da,
de,
de-CH,
de-DE,
el,
en,
en-GB,
en-US,
es,
es-419,
es-ES,
et,
fi,
fr,
fr-CA,
fr-FR,
he,
hu,
id,
it,
ja,
ko,
lt,
lv,
nb,
nl,
pl,
pt,
pt-BR,
pt-PT,
ro,
ru,
sk,
sl,
sv,
tr,
uk,
vi,
zh,
zh-Hans,
zh-Hant
Example:

"de"

entries
string

The entries of the glossary. The entries have to be specified in the format provided by the entries_format parameter.

Example:

"Hello\tGuten Tag"

entries_format
enum<string>
default:tsv

The format in which the glossary entries are provided. Formats currently available:

  • tsv (default) - tab-separated values
  • csv - comma-separated values

See Supported Glossary Formats for details about each format.

Available options:
tsv,
csv
Example:

"tsv"

Response

JSON object containing the dictionary meta-information.

source_lang
enum<string>

The language in which the source texts in the glossary are specified.

Available options:
ar,
bg,
cs,
da,
de,
el,
en,
es,
et,
fi,
fr,
he,
hu,
id,
it,
ja,
ko,
lt,
lv,
nb,
nl,
pl,
pt,
ro,
ru,
sk,
sl,
sv,
tr,
uk,
vi,
zh
Example:

"en"

target_lang
enum<string>

The language in which the target texts in the dictionary are specified. Besides the base languages, the target can be one of these variants: de-CH, de-DE, en-GB, en-US, es-419, es-ES, fr-CA, fr-FR, pt-BR, pt-PT, zh-Hans, or zh-Hant. Source languages are always base languages. The current list is returned by GET /v3/languages?resource=glossary.

A dictionary with a base target, such as de, applies when translating into that language and any of its variants. A dictionary with a variant target, such as de-CH, applies only when translating into that exact variant.

Within one glossary, each language family uses either the base language or its variants as targets, not both. For example, de-CH and de-DE can be combined, but de and de-DE cannot. Adding a dictionary that breaks this rule returns a 400 error.

Available options:
ar,
bg,
cs,
da,
de,
de-CH,
de-DE,
el,
en,
en-GB,
en-US,
es,
es-419,
es-ES,
et,
fi,
fr,
fr-CA,
fr-FR,
he,
hu,
id,
it,
ja,
ko,
lt,
lv,
nb,
nl,
pl,
pt,
pt-BR,
pt-PT,
ro,
ru,
sk,
sl,
sv,
tr,
uk,
vi,
zh,
zh-Hans,
zh-Hant
Example:

"de"

entry_count
integer

The number of entries in the glossary.