Update a style profile

Learn how to rename a style profile, clear its description or industry, and replace the set of components it links.

PATCH /v3/style_profiles/{style_profile_id}

cURL

RenameOnly

curl --request PATCH \
  --url https://api.deepl.com/v3/style_profiles/{style_profile_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Legal, German (2026)"
}
'

200

Basic

{
  "style_profile_id": "3f1c9d0e-7a24-4b58-9c31-8f0e5d2a1b47",
  "name": "Legal, German (2026)",
  "description": "Contract wording for the German market.",
  "industry": "Legal",
  "glossary_ids": [
    "4d0a2e1c-6b93-4f7a-8d15-2c6e9a3b7f81",
    "7b2f6d84-3c15-4e90-8a72-d5e1490bc637"
  ],
  "style_rule_ids": [
    "bd0a38f3-1831-440b-a8dd-2c702e2325ab"
  ],
  "translation_memory_ids": [
    "a74d88fb-ed2a-4943-a664-a4512398b994"
  ],
  "example_document_ids": [],
  "spoken_terms_id": "def3a26b-3e84-45b3-84ae-0c0aaf3525f7",
  "glossary_priority_enabled": true,
  "creation_time": "2026-04-01T16:34:25.223Z",
  "updated_time": "2026-08-20T13:47:51.902Z"
}

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. A style profile always has a name, so an empty string is rejected with 400 Bad Request rather than clearing it.

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, in the order they should be applied. Replaces the linked glossaries in full. Send an empty list to unlink all of them.

Example:

["4d0a2e1c-6b93-4f7a-8d15-2c6e9a3b7f81"]

style_rule_ids · string<uuid>[]

The IDs of the style rule lists to link, in the order they should be applied. 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:

["bd0a38f3-1831-440b-a8dd-2c702e2325ab"]

translation_memory_ids · string<uuid>[]

The IDs of the translation memories to link, in the order they should be applied. 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:

["a74d88fb-ed2a-4943-a664-a4512398b994"]

example_document_ids · string<uuid>[]

The IDs of the example documents to link, in the order they should be applied. A document must be fully imported before it can be linked. Replaces the linked example documents in full. Send an empty list to unlink all of them.

Example:

["9e7b41c2-58da-4a03-b6f1-3c85e0d97a26"]

spoken_terms_id · string<uuid>

The ID of the Spoken Terms collection to link, applied when the style profile is used for speech rather than text. A style profile links at most one collection, so a new ID replaces the current link. Send an empty string to unlink the collection, the same way an empty string clears description and industry.

Requires a plan that includes DeepL Voice. Sending a spoken_terms_id on a plan without it is rejected with 403 Forbidden and the style profile is not changed. A value that is not a valid UUID, or that names a collection your account cannot access, is rejected with 400 Bad Request naming the field.

Example:

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

glossary_priority_enabled · boolean

Whether the glossaries linked to this style profile take priority over its other components.

Example:

true

Response

200

application/json

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. A style profile always has a name, so it cannot be cleared once it is set.

Example:

"Legal, German"

glossary_ids · string<uuid>[] · required

The IDs of the glossaries linked to the style profile, in the order they are applied.

Example:

["4d0a2e1c-6b93-4f7a-8d15-2c6e9a3b7f81"]

style_rule_ids · string<uuid>[] · required

The IDs of the style rule lists linked to the style profile, in the order they are applied.

Example:

["bd0a38f3-1831-440b-a8dd-2c702e2325ab"]

translation_memory_ids · string<uuid>[] · required

The IDs of the translation memories linked to the style profile, in the order they are applied. A style profile links at most one translation memory per source language.

Example:

["a74d88fb-ed2a-4943-a664-a4512398b994"]

example_document_ids · string<uuid>[] · required

The IDs of the example documents linked to the style profile, in the order they are applied.

Example:

["9e7b41c2-58da-4a03-b6f1-3c85e0d97a26"]

glossary_priority_enabled · boolean · required

Whether the glossaries linked to the style profile take priority over its other components.

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"

spoken_terms_id · string<uuid>

The ID of the Spoken Terms collection linked to the style profile, applied when the profile is used for speech rather than text. A style profile links at most one collection. Omitted from the response when no collection is linked. Collections are managed with the Spoken Terms endpoints.

Example:

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