Skip to main content
POST
Add emails to the ban list

Authorizations

Authorization
string
header
required

Mobile token, global API token, series API key, or event API key. See Authentication above for which endpoints each one reaches.

Body

application/json
email
string

A single email to ban. Use emails for several.

Example:

"banned@example.com"

emails
string[]

Every email belonging to the person. Case and surrounding whitespace are normalised, and duplicates collapse.

reason
string | null

Free text shown to admins in the ban list.

expires_at
string<date-time> | null

ISO 8601 timestamp the ban lifts at. Omit for an indefinite ban. A value that isn't ISO 8601 is rejected rather than treated as absent.

Response

Ban created.

ban
object