brand-standards

Get Terminology Rule

Get a specific terminology rule

get/api/brand-standards/rules/{rule_id}

Request

  • Base URL: https://voyant.io (the document declares no server; this is the origin it was published from)
  • URL: https://voyant.io/api/brand-standards/rules/{rule_id}
  • Auth: HTTP bearer

Path parameters

rule_idstring required

Response

Successful Response

incorrect_termstring required

The incorrect term or pattern to match

correct_termstring required

The correct term to use instead

categorystring

Category: legal, style, or banned

case_sensitiveboolean

Whether matching is case-sensitive

enforcementstring

Enforcement level: block or warn

use_regexboolean

Whether incorrect_term is a regex pattern

notesstring nullable

Additional notes about this rule

is_activeboolean

Whether this rule is active

idstring required
org_idstring required
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.