Update style guide rules

curl --request PATCH \
  --url https://api.dittowords.com/v2/styleguides/rules \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "updates": [
    {
      "ruleId": "be-concise",
      "name": "Be extremely concise",
      "examples": [
        {
          "from": "Please click the button below",
          "to": "Click below"
        }
      ]
    }
  ]
}
'

{
  "success": true
}

{
  "message": "Rule 'be-concise' is in a rules section; use 'name'/'examples' instead of 'term'/'disallowed'."
}

{
  "message": "Rule id not found: missing-rule"
}

PATCH

styleguides

rules

curl --request PATCH \
  --url https://api.dittowords.com/v2/styleguides/rules \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "updates": [
    {
      "ruleId": "be-concise",
      "name": "Be extremely concise",
      "examples": [
        {
          "from": "Please click the button below",
          "to": "Click below"
        }
      ]
    }
  ]
}
'

{
  "success": true
}

{
  "message": "Rule 'be-concise' is in a rules section; use 'name'/'examples' instead of 'term'/'disallowed'."
}

{
  "message": "Rule id not found: missing-rule"
}

Authorizations

Authorization

string

header

required

Body

application/json

updates

object[]

required

Rules to update, identified by ruleId. Only provided fields are changed. Use 'name'/'examples' for a rule in a 'rules' section, or 'term'/'disallowed' for a rule in a 'wordlist' section — the shape must match that rule's own section.

Minimum array length: 1

Option 1
Option 2

Show child attributes

Response

Returns success status of the update operation

success

boolean

required

Indicates whether the update was successful

Overview

API Reference

CLI Reference

Agent Setup Package

MCP Reference

Ditto Specs CLI Reference

Additional Tools

Legacy

Update style guide rules

Authorizations

Body

Response