Create a Rule
Creates a Rule for the authenticated organization. When omitted, active and aiCheckEnabled each default to true, but only if doing so would not exceed the active-rule limit (50) or AI-check limit (20) for every (Content Group, Language) pair the rule applies to; otherwise they default to false. Explicit true values that would exceed a limit are rejected with 409 CONFLICT.
Authorizations
JWT from IDM (Authorization: Bearer )
Body
Request to create a new Rule
Rule text
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 (default), contentGroupIds must be provided and non-empty.
false
Content Group IDs this rule applies to. Must be non-empty when allContentGroups is false. Must be absent or empty when allContentGroups is true.
10036When true, this rule applies to all languages and languages must be absent or empty. When false (default), languages must be provided and non-empty.
false
Language codes this rule applies to (e.g., en, en-GB). Must be non-empty when allLanguages is false. Must be absent or empty when allLanguages is true.
1001Whether this rule is active. If omitted, defaults to true unless any (Content Group, Language) pair the rule applies to already has 50 active rules, in which case it defaults to false. If explicitly set to true and any applicable pair already has 50 active rules, the request fails with 409 CONFLICT (ACTIVE_RULE_LIMIT_REACHED).
true
Whether this rule is used during AI-powered quality checks. Requires the rule to be active (explicitly or by default); explicitly setting this to true while active is false and not also being set to true fails with 400 (VALIDATION_ERROR). If omitted on an active rule, defaults to true unless any (Content Group, Language) pair the rule applies to already has 20 AI-check-enabled rules, in which case it defaults to false. If explicitly set to true and any applicable pair already has 20 AI-check-enabled rules, the request fails with 409 CONFLICT (AI_CHECK_LIMIT_REACHED).
true
Response
Rule created 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