DEdeepl

Replace a custom instruction

Changed on

Replace a custom instruction. Send every field you want to keep, because omitted fields are overwritten.

put/v3/style_rules/{style_id}/custom_instructions/{instruction_id}

Request

  • Base URL
    https://api.deepl.com
  • URL
    https://api.deepl.com/v3/style_rules/{style_id}/custom_instructions/{instruction_id}
  • Auth
    API key in header Authorization

Path parameters

style_idstring required

The ID of the style rule list

instruction_idstring required

The ID of the custom instruction

Request body

labelstring required

Updated label for the custom instruction

promptstring required

Updated instruction text

source_languagestring

Optional source language code

Response

Custom instruction updated successfully

idstring required

Unique identifier for the custom instruction

labelstring required

Name associated with the custom instruction

promptstring required

Prompt of the custom instruction

source_languagestring

Optional source language of the custom instruction

Example response

{
  "id": "68fdb803-c013-4e67-b62e-1aad0ab519cd",
  "label": "Currency custom instruction",
  "prompt": "Have currency symbols before the numerical value (e.g. $100, €100)",
  "source_language": "en"
}

Changes

  • c7c91cfac5c0Revision changes
    • 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