curl --request PATCH \
--url https://api.dittowords.com/v2/styleguides \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"developerId": "acme-inc",
"name": "Acme Inc. Style Guide"
}
'{
"success": true
}{
"message": "At least one wordlist section is required"
}{
"message": "Style guide with developer ID 'acme-inc' not found"
}Update a style guide
Updates a style guide’s name, description, enabled-by-default setting, or sections.
Each style guide is identified by its developer ID. Only provided fields are modified.
curl --request PATCH \
--url https://api.dittowords.com/v2/styleguides \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"developerId": "acme-inc",
"name": "Acme Inc. Style Guide"
}
'{
"success": true
}{
"message": "At least one wordlist section is required"
}{
"message": "Style guide with developer ID 'acme-inc' not found"
}Body
Developer ID of a variant to scope this style guide to — its rules then apply only to text in that variant. Currently, this is only supported for variants with a locale code. Pass null to clear the variant so the style guide applies to all text. If not provided, the variant is unchanged.
Scoping a style guide to a variant is how it's associated with a locale, because a locale in Ditto is a variant's locale code. Use GET /v2/variants to find the variant whose locale code matches the locale you want, rather than inferring it from the variant's name.
1Full replacement list of sections — the array you pass replaces all existing sections.
Each section's sectionId must be unique within the style guide, and the list must include at least one 'rules' section and one 'wordlist' section. Rules belonging to a removed section are automatically moved to the first remaining rules section.
Show child attributes
Show child attributes