Create style guide rules

curl --request POST \
  --url https://api.dittowords.com/v2/styleguides/rules \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "styleguideId": "acme-inc",
  "sectionId": "foundations",
  "rules": [
    {
      "name": "Be concise",
      "description": "Remove filler words so text is easy to scan.",
      "examples": [
        {
          "from": "Please click the button below",
          "to": "Click below"
        }
      ]
    },
    {
      "name": "Use sentence case for headings",
      "enabled": false
    }
  ]
}
'

{
  "ids": [
    "be-concise"
  ]
}

{
  "message": "Section 'word-list' is a wordlist; each entry must provide 'term' (and optional 'disallowed')."
}

{
  "message": "Style guide with developer ID 'acme-inc' not found"
}

POST

styleguides

rules

curl --request POST \
  --url https://api.dittowords.com/v2/styleguides/rules \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "styleguideId": "acme-inc",
  "sectionId": "foundations",
  "rules": [
    {
      "name": "Be concise",
      "description": "Remove filler words so text is easy to scan.",
      "examples": [
        {
          "from": "Please click the button below",
          "to": "Click below"
        }
      ]
    },
    {
      "name": "Use sentence case for headings",
      "enabled": false
    }
  ]
}
'

{
  "ids": [
    "be-concise"
  ]
}

{
  "message": "Section 'word-list' is a wordlist; each entry must provide 'term' (and optional 'disallowed')."
}

{
  "message": "Style guide with developer ID 'acme-inc' not found"
}

Authorizations

Authorization

string

header

required

Body

application/json

styleguideId

string

required

Developer ID of the style guide to attach the rules to (from GET /styleguides).

Minimum string length: 1

sectionId

string

required

ID of the section within the style guide to attach the rules to (from GET /styleguides).

Minimum string length: 1

rules

object

required

Option 1 · object[]
Option 2 · object[]

Show child attributes

Response

Returns the Developer IDs of the created rules, in request order

ids

string[]

required

Developer IDs of the created rules, in request order.

Overview

API Reference

CLI Reference

Agent Setup Package

MCP Reference

Ditto Specs CLI Reference

Additional Tools

Legacy

Create style guide rules

Authorizations

Body

Response