DEdeepl
ManageStyleProfiles

Create a style profile

Changed on

Create a style profile. Only name is required.

If any of the component IDs cannot be used, the request fails and no style profile is created.

Requires an API key with the style_profiles:write scope.

post/v3/style_profiles

Request

  • Base URL
    https://api.deepl.com
  • URL
    https://api.deepl.com/v3/style_profiles
  • Auth
    API key in header Authorization

Request body

namestring required

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

descriptionstring

Free-text description of the style profile. At most 1000 characters. Omit it to create the style profile without a description.

industrystring

The industry the style profile is written for. At most 255 characters. Omit it to create the style profile without an industry.

glossary_idsstring[]

The IDs of the glossaries to link, highest priority first. The order only takes effect with glossary_priority_order_enabled. Defaults to an empty list.

style_rule_idsstring[]

The IDs of the style rule lists to link. At most one style rule list per target language. Defaults to an empty list.

translation_memory_idsstring[]

The IDs of the translation memories to link. At most one translation memory per source language. Defaults to an empty list.

glossary_priority_order_enabledboolean

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. Defaults to false.

Example request

{
  "name": "Legal, German",
  "description": "Contract wording for the German market.",
  "industry": "Legal",
  "glossary_ids": [
    "4d0a2e1c-6b93-4f7a-8d15-2c6e9a3b7f81"
  ],
  "style_rule_ids": [
    "bd0a38f3-1831-440b-a8dd-2c702e2325ab"
  ],
  "translation_memory_ids": [
    "a74d88fb-ed2a-4943-a664-a4512398b994"
  ],
  "glossary_priority_order_enabled": true
}

Response

Returns the created style profile.

style_profile_idstring uuid required

A unique ID assigned to a style profile.

namestring required

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

descriptionstring

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

industrystring

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

glossary_idsstring[] required

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

style_rule_idsstring[] 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.

translation_memory_idsstring[] required

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

glossary_priority_order_enabledboolean 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.

creation_timestring 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).

updated_timestring 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 response

{
  "style_profile_id": "3f1c9d0e-7a24-4b58-9c31-8f0e5d2a1b47",
  "name": "Legal, German",
  "description": "Contract wording for the German market.",
  "industry": "Legal",
  "glossary_ids": [
    "4d0a2e1c-6b93-4f7a-8d15-2c6e9a3b7f81"
  ],
  "style_rule_ids": [
    "bd0a38f3-1831-440b-a8dd-2c702e2325ab"
  ],
  "translation_memory_ids": [
    "a74d88fb-ed2a-4943-a664-a4512398b994"
  ],
  "glossary_priority_order_enabled": true,
  "creation_time": "2026-04-01T16:34:25.223Z",
  "updated_time": "2026-08-06T09:12:44.108Z"
}

Changes