Members

Actions in the category "Members".

Kick member

Kicks a member from your server.

Required permissions: Kick members.

Inputs

Name	Type	Required	Details
Member	Server member	Yes	Member to kick.
Audit log reason	Text	No	Reason recorded in the audit log. Maximum length: 512 characters.

Time out member

Puts a member into timeout for a given duration.

Required permissions: Time out members.

Inputs

Name	Type	Required	Details
Member	Server member	Yes	Member to time out.
Duration	Duration	Yes	Length of the timeout (max 28 days). Value: 0 to 2419200000.
Audit log reason	Text	No	Reason recorded in the audit log. Maximum length: 512 characters.

Set member nickname

Sets or clears a member's nickname.

Required permissions: Manage nicknames.

Inputs

Name	Type	Required	Details
Member	Server member	Yes	Member to update.
Nickname	Text	No	New nickname. Leave empty to remove the nickname. Maximum length: 32 characters.
Audit log reason	Text	No	Reason recorded in the audit log. Maximum length: 512 characters.

Add role to member

Gives a role to a member.

Required permissions: Manage roles.

Inputs

Name	Type	Required	Details
Member	Server member	Yes	Member to grant the role to.
Role	Role	Yes	Role to add.
Audit log reason	Text	No	Reason recorded in the audit log. Maximum length: 512 characters.

Member has role

Checks whether a member currently has a given role.

Inputs

Name	Type	Required	Details
Member	Server member	Yes	Member to check.
Role	Role	Yes	Role to check for.

Outputs

Name	Type	Details
Has role	Yes/No	True if the member has the role.

Member has permission

Checks whether a member has a given permission. Without a channel this checks their server-wide permissions; with a channel it checks their effective permissions there, including channel overwrites. Administrators and the server owner count as having every permission.

Inputs

Name	Type	Required	Details
Member	Server member	Yes	Member to check.
Permission	Permission	Yes	Permission to check for.
Channel	Server channel	No	Optional. Check the permission inside this channel (overwrites applied) instead of server-wide.

Outputs

Name	Type	Details
Has permission	Yes/No	True if the member has the permission.

Remove role from member

Takes a role away from a member.

Required permissions: Manage roles.

Inputs

Name	Type	Required	Details
Member	Server member	Yes	Member to remove the role from.
Role	Role	Yes	Role to remove.
Audit log reason	Text	No	Reason recorded in the audit log. Maximum length: 512 characters.

Set member roles

Replaces all roles of a server member with the provided role list.

Required permissions: Manage roles.

Inputs

Name	Type	Required	Details
Member	Server member	Yes	The member whose roles will be replaced.
Roles	List of Role	Yes	The full set of roles the member should have after this action.
Audit Log Reason	Text	No	Reason logged in the audit log. Maximum length: 512 characters.

Outputs

Name	Type	Details
Member	Server member	The updated member.

Remove timeout from member

Clears an active communication timeout from a member.

Required permissions: Time out members.

Inputs

Name	Type	Required	Details
Member	Server member	Yes	The member to remove the timeout from.
Audit Log Reason	Text	No	Reason logged in the audit log. Maximum length: 512 characters.

Outputs

Name	Type	Details
Member	Server member	The updated member.

Send DM to member

Sends a direct message to a server member.

Inputs

Name	Type	Required	Details
Member	Server member	Yes	The recipient of the direct message.
Message Content	Message content	Yes	The message to deliver.

Outputs

Name	Type	Details
Message	Message	The sent message, or empty if delivery failed. May be empty.

Create DM channel with user

Opens or returns the existing direct message channel with a user.

Inputs

Name	Type	Required	Details
User	User	Yes	The user to open a DM channel with.

Outputs

Name	Type	Details
DM Channel	Direct message	The opened DM channel.

Fetch member by ID

Looks up a server member using their user ID.

Inputs

Name	Type	Required	Details
User ID	Discord ID	Yes	The Discord user ID to look up.

Outputs

Name	Type	Details
Member	Server member	The found member, or empty if not in the server. May be empty.

Fetch members

Returns a paginated list of the server's members, read from the bot's member cache. Requires the Server Members intent: if it is not enabled for the bot, or the member list is still loading, the action fails with an error instead of returning an incomplete list.

Inputs

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

Outputs

Name	Type	Details
Members	List of Server member	The list of fetched members.

Fetch member voice state

Returns the voice state for a member, or empty if they are not in a voice channel.

Inputs

Name	Type	Required	Details
Member	Server member	Yes	The member to look up.

Outputs

Name	Type	Details
Voice State	Voice state	The voice state, or empty if absent. May be empty.

Prune inactive members

Removes members inactive for the specified number of days.

Required permissions: Kick members.

Inputs

Name	Type	Required	Details
Inactivity Days	Whole number	Yes	Number of days a member must be inactive to be pruned (1-30). Value: 1 to 30. Default: 7.
Included Roles	List of Role	No	Members holding any of these roles will also be considered for pruning.
Dry Run	Yes/No	No	If true, only counts members without removing them. Default: No.
Audit Log Reason	Text	No	Reason logged in the audit log. Maximum length: 512 characters.

Outputs

Name	Type	Details
Pruned Count	Whole number	Number of members pruned (or matched in dry-run mode).

Fetch prune count

Returns how many members would be pruned given the criteria.

Required permissions: Kick members.

Inputs

Name	Type	Required	Details
Inactivity Days	Whole number	Yes	Number of days a member must be inactive (1-30). Value: 1 to 30. Default: 7.
Included Roles	List of Role	No	Optional roles to include in the prune calculation.

Outputs

Name	Type	Details
Count	Whole number	The number of members that would be pruned.

Fetch member permissions in channel

Returns the effective permissions a member has in a specific channel.

Inputs

Name	Type	Required	Details
Member	Server member	Yes	The member to evaluate.
Channel	Server channel	Yes	The channel to compute permissions for.

Outputs

Name	Type	Details
Permissions	List of Permission	The list of permission flags the member holds in the channel.

Kick user by ID

Kicks a member from the server using their user ID.

Required permissions: Kick members.

Inputs

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

Outputs

Name	Type	Details
Kicked User ID	Discord ID	The ID of the kicked user.

Fetch member by username

Finds a member on the server by username (and optionally nickname).

Inputs

Name	Type	Required	Details
Username	Text	Yes	Username to search for. Length: 2 to 32 characters.
Include nicknames	Yes/No	Yes	Also match against members' server nicknames. Default: Yes.

Outputs

Name	Type	Details
Member	Server member	The first matching member, or empty. May be empty.

Search members by name

Searches the server for members whose username or nickname starts with a query (via Discord's search endpoint, not a full member fetch).

Inputs

Name	Type	Required	Details
Query	Text	Yes	Name prefix to search for (matches usernames and nicknames). Length: 1 to 100 characters.
Limit	Whole number	No	Maximum number of members to return (1-100). Value: 1 to 100. Default: 10.

Outputs

Name	Type	Details
Members	List of Server member	The matching members.