Bans

Actions in the category "Bans".

Ban member

Bans a member from your server.

Required permissions: Ban members.

Inputs

Name	Type	Required	Details
Member	Server member	Yes	Member to ban.
Delete recent messages	Duration	Yes	Delete messages sent within this period (max 7 days). Value: 0 to 604800000. Default: 0.
Audit log reason	Text	No	Reason recorded in the audit log. Maximum length: 512 characters.

Ban user by ID

Bans a user by their ID, even if they are not currently a member of the server.

Required permissions: Ban members.

Inputs

Name	Type	Required	Details
User ID	Discord ID	Yes	The Discord user ID to ban.
Delete Message Seconds	Whole number	No	Number of seconds of message history to delete (0-604800). Value: 0 to 604800. Default: 0.
Audit Log Reason	Text	No	Reason logged in the audit log. Maximum length: 512 characters.

Outputs

Name	Type	Details
Banned User ID	Discord ID	The ID of the banned user.

Unban user

Removes an existing ban for a user.

Required permissions: Ban members.

Inputs

Name	Type	Required	Details
User	User	Yes	The user to unban.
Audit Log Reason	Text	No	Reason logged in the audit log. Maximum length: 512 characters.

Outputs

Name	Type	Details
User	User	The unbanned user.

Bulk ban members

Bans multiple users in a single operation.

Required permissions: Ban members.

Inputs

Name	Type	Required	Details
Users	List of User	Yes	The users to ban (1-200). Items: 1 to 200.
Delete Message Seconds	Whole number	No	Number of seconds of message history to delete (0-604800). Value: 0 to 604800. Default: 0.
Audit Log Reason	Text	No	Reason logged in the audit log. Maximum length: 512 characters.

Outputs

Name	Type	Details
Banned IDs	List of Discord ID	IDs of the users that were successfully banned.
Failed IDs	List of Discord ID	IDs of the users that could not be banned.

Fetch ban

Returns the ban entry for a user, or empty if they are not banned.

Required permissions: Ban members.

Inputs

Name	Type	Required	Details
User	User	Yes	The user to check.

Outputs

Name	Type	Details
Ban	Ban	The ban entry, or empty if not banned. May be empty.

Fetch bans

Returns a paginated list of bans for the server.

Required permissions: Ban members.

Inputs

Name	Type	Required	Details
Limit	Whole number	No	Maximum number of bans to return (1-1000). Value: 1 to 1000. Default: 100.
Before	Discord ID	No	Return bans with IDs less than this value.
After	Discord ID	No	Return bans with IDs greater than this value.

Outputs

Name	Type	Details
Bans	List of Ban	The list of bans.