Skip to content

User Ban

INFO

The User Ban object is only used within the ban field on User objects. It should not appear anywhere else.

Structure

FieldTypeDescription
statestringThe current state of the ban. Can be "none", "temp_restriction", "perm_restriction", "temp_ban", or "perm_ban".
restrictions*integer
expires**integerThe expiration timestamp of the ban in Unix seconds.
reasonstringThe reason for the ban.

* These fields are only effective when state is set to "temp_restriction" or "perm_restriction".

** These fields are only effective when state is set to "temp_restriction" or "temp_ban".

Example

json
{
	"state": "temp_restriction",
	"restrictions": 31,
	"expires": 1704587880,
	"reason": "Being too silly :p"
}