Skip to main content
PATCH
Update a Rule

Authorizations

Authorization
string
header
required

JWT from IDM (Authorization: Bearer )

Path Parameters

id
string<uuid>
required

Rule ID

Body

application/json

Request to update an existing Rule. Only fields that are present (non-null) in the JSON body are applied.

rule
string

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.

Maximum string length: 450
Example:

"Avoid passive voice in all user-facing content."

allContentGroups
boolean

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.

contentGroupIds
string[]

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.

Maximum array length: 100
Maximum string length: 36
allLanguages
boolean

When 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.

languages
string[]

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.

Maximum array length: 100
Minimum string length: 1
active
boolean

Whether this rule is active. Null = no change.

aiCheckEnabled
boolean

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

id
string<uuid>
required

Unique identifier for this Rule

Example:

"01900000-0000-7000-8000-000000000001"

rule
string
required

The rule text

Example:

"Avoid passive voice in all user-facing content."

active
boolean
required

Whether this rule is active

aiCheckEnabled
boolean
required

Whether this rule is used during AI-powered quality checks

allContentGroups
boolean
required

Whether this rule applies to all content groups

allLanguages
boolean
required

Whether this rule applies to all languages

contentGroups
object[] | null
required

Content Groups this rule applies to. Empty list means all content groups. Null means no content groups are assigned.

languages
object[] | null
required

Language details for languages this rule applies to. Empty list means all languages. Null means no languages are assigned.

createdAt
string<date-time>
required

When this rule was created

Example:

"2024-01-15T10:30:00Z"

lastModifiedAt
string<date-time>
required

When this rule was last modified

Example:

"2024-06-01T14:22:00Z"

styleGuide
null

Style Guide this rule was extracted from. Null when the rule is unlinked — either manually created or subsequently edited.

createdBy
null

User who created this rule

lastModifiedBy
null

User who last modified this rule