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"
}Style guides
Update style guide rules
Updates a set of style guide rules, each identified by its Developer ID.
Only provided fields are modified. The operation is all-or-nothing: if any update is invalid, none are applied.
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
Body
application/json
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
Show child attributes
Response
Returns success status of the update operation
Indicates whether the update was successful