Update a Rule
Updates a Rule. Only fields present (non-null) in the request body are applied. Editing the text, or removing the linked Style Guide’s content group or language, would unlink the rule from its Style Guide; set forceUnlink=true to confirm, otherwise the request fails with 409 CONFLICT and no changes are applied.
Authorizations
JWT from IDM (Authorization: Bearer )
Path Parameters
Rule ID
Body
Request to update an existing Rule. Only fields that are present (non-null) in the JSON body are applied.
Updated rule text. Changing it would unlink the rule from its Style Guide; set forceUnlink=true to confirm, otherwise the request fails with 409 CONFLICT.
450"Avoid passive voice in all user-facing content."
When true, this rule applies to all content groups and contentGroupIds must be absent or empty. When false, contentGroupIds must be provided and non-empty. Null = no change. Changing the content group scope away from the linked Style Guide's content group would unlink the rule; set forceUnlink=true to confirm, otherwise the request fails with 409 CONFLICT.
Complete replacement of the Content Group IDs this rule applies to. Null = no change. Must be non-empty when allContentGroups is false; must be absent or empty when allContentGroups is true. Any previously set IDs not included here are removed. Removing the linked Style Guide's content group would unlink the rule; set forceUnlink=true to confirm, otherwise the request fails with 409 CONFLICT.
10036When true, this rule applies to all languages and languages must be absent or empty. When false, languages must be provided and non-empty. Null = no change. Changing the language scope away from the linked Style Guide's language would unlink the rule; set forceUnlink=true to confirm, otherwise the request fails with 409 CONFLICT.
Complete replacement of the language codes this rule applies to. Null = no change. Must be non-empty when allLanguages is false; must be absent or empty when allLanguages is true. Any previously set codes not included here are removed. Removing the linked Style Guide's language would unlink the rule; set forceUnlink=true to confirm, otherwise the request fails with 409 CONFLICT.
1001Whether this rule is active. Null = no change.
Whether this rule is used during AI-powered quality checks. Null = no change.
Confirms that this update may unlink the rule from its currently linked Style Guide. Required (must be true) when a change to rule text, content group scope, or language scope would cause an unlink; otherwise the request fails with 409 CONFLICT and no changes are applied. Default: false.
Response
Rule updated successfully
Rule details
Unique identifier for this Rule
"01900000-0000-7000-8000-000000000001"
The rule text
"Avoid passive voice in all user-facing content."
Whether this rule is active
Whether this rule is used during AI-powered quality checks
Whether this rule applies to all content groups
Whether this rule applies to all languages
Content Groups this rule applies to. Empty list means all content groups. Null means no content groups are assigned.
Language details for languages this rule applies to. Empty list means all languages. Null means no languages are assigned.
When this rule was created
"2024-01-15T10:30:00Z"
When this rule was last modified
"2024-06-01T14:22:00Z"
Style Guide this rule was extracted from. Null when the rule is unlinked — either manually created or subsequently edited.
User who created this rule
User who last modified this rule