documentation/content/en/entities/Rule.md

title	description	menu	aliases
Rule	Represents a rule that server users should follow.	docs parent entities	/entities/rule /entities/Rule /api/entities/rule /api/entities/Rule

Example

{
	"id": "2",
	"text": "No racism, sexism, homophobia, transphobia, ableism, xenophobia, or casteism.",
	"hint": "Transphobic behavior such as intentional misgendering and deadnaming is strictly prohibited. Promotion of \"conversion therapy\" is strictly prohibited. Criticism of governments and religions is permissible unless being used as a proxy for discrimination."
}

Attributes

id

Description: An identifier for the rule.
Type: String (cast from integer, but not guaranteed to be a number)
Version history:
3.4.0 - added

text

Description: The rule to be followed.
Type: String
Version history:
3.4.0 - added

hint

Description: Longer-form description of the rule.
Type: String
Version history:
4.3.0 - added

See also

{{< page-relref ref="methods/instance#rules" caption="GET /api/v1/instance/rules" >}}

{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/models/rule.rb" caption="app/models/rule.rb" >}}

{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/serializers/rest/rule_serializer.rb" caption="app/serializers/rest/rule_serializer.rb" >}}