Skip to main content
PATCH

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

style_profile_id
string<uuid>
required

The ID of the style profile to update. A unique ID assigned to a style profile.

Example:

"3f1c9d0e-7a24-4b58-9c31-8f0e5d2a1b47"

Body

application/json
name
string

A new name for the style profile. At most 255 characters. An empty string is rejected with 400 Bad Request.

Example:

"Legal, German (2026)"

description
string

A new description for the style profile. At most 1000 characters. Send an empty string to clear it.

Example:

"Contract wording for the German market, 2026 revision."

industry
string

A new industry for the style profile. At most 255 characters. Send an empty string to clear it.

Example:

"Legal"

glossary_ids
string<uuid>[]

The IDs of the glossaries to link, highest priority first. The order only takes effect with glossary_priority_order_enabled. Replaces the linked glossaries in full. Send an empty list to unlink all of them.

Example:
style_rule_ids
string<uuid>[]

The IDs of the style rule lists to link. At most one style rule list per target language. Replaces the linked style rule lists in full. Send an empty list to unlink all of them.

Example:
translation_memory_ids
string<uuid>[]

The IDs of the translation memories to link. At most one translation memory per source language. Replaces the linked translation memories in full. Send an empty list to unlink all of them.

Example:
glossary_priority_order_enabled
boolean

Whether the order of glossary_ids sets priority: when two linked glossaries define the same source term, the one listed first wins. When false, the order has no effect.

Example:

true

Response

Returns the updated style profile.

style_profile_id
string<uuid>
required

A unique ID assigned to a style profile.

Example:

"3f1c9d0e-7a24-4b58-9c31-8f0e5d2a1b47"

name
string
required

Name associated with the style profile. At most 255 characters.

Example:

"Legal, German"

glossary_ids
string<uuid>[]
required

The IDs of the glossaries linked to the style profile, highest priority first. The order only takes effect with glossary_priority_order_enabled.

Example:
style_rule_ids
string<uuid>[]
required

The IDs of the style rule lists linked to the style profile. A style profile links at most one style rule list per target language.

Example:
translation_memory_ids
string<uuid>[]
required

The IDs of the translation memories linked to the style profile. A style profile links at most one translation memory per source language.

Example:
glossary_priority_order_enabled
boolean
required

Whether the order of glossary_ids sets priority: when two linked glossaries define the same source term, the one listed first wins. When false, the order has no effect.

Example:

true

creation_time
string<date-time>
required

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

Example:

"2026-04-01T16:34:25.223Z"

updated_time
string<date-time>
required

The time of the last update to the style profile in the ISO 8601-1:2019 format (e.g.: 2021-08-03T14:16:18.329Z).

Example:

"2026-08-06T09:12:44.108Z"

description
string

Free-text description of the style profile. At most 1000 characters. Omitted from the response when the style profile has no description.

Example:

"Contract wording for the German market."

industry
string

The industry the style profile is written for. At most 255 characters. Omitted from the response when the style profile has no industry.

Example:

"Legal"