Stats

Add an email-domain rule

Admin-only. Adds a block or allow rule. Applies to new signups and address changes at once; existing users keep their sign-in. Records email_domain.added.

post/stats/email-domains

Request

  • Base URL: https://api.nippy.host
  • URL: https://api.nippy.host/stats/email-domains
  • Auth: bearer (a scheme the document does not define)

Request body

domainstring required

Domain to match, e.g. example.com. A leading @ or *. and a trailing dot are ignored. The rule also covers every subdomain.

kind'block' | 'allow' required

block refuses new signups on the domain; allow exempts it from every block, including the community list.

notestring

Why the rule exists — typically the incident behind it.

Response

idstring required

Rule id (UUID).

domainstring required

The domain; the rule also covers subdomains.

kind'block' | 'allow' required
notestring nullable required
createdByNamestring nullable required

Display name of the admin who added the rule; null for seeded rules or a deleted admin.

createdAtstring required

When the rule was added (ISO 8601).

existingUsersnumber required

Existing users with an address on the domain or a subdomain. They keep their sign-in: rules only apply to new addresses.

Changes

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