Moderation
threadRemoveMember
$threadRemoveMember
The function $threadRemoveMember[] allows you to remove a user from a thread. The user will no longer be able to access the private thread.
Syntax
$threadRemoveMember[threadID;userID]
Parameters
| Parameter | Description |
|---|---|
threadID |
The ID of the target thread (a Discord ID of a thread; otherwise an error is raised). |
userID |
The ID of the user to remove (a Discord ID, otherwise Invalid Discord ID.). |
Return Value
This function does not return any value.
Behavior
- The thread must not be archived (
Thread is archived.). - The bot needs
View ChannelandManage Threadsin the thread, unless it is a private thread created by the bot (then onlyView Channel); otherwiseMissing permissions for the thread operation.is raised.
Examples
Closing a Ticket
$threadRemoveMember[123456789012345678;$authorID]
$editThread[123456789012345678;[Closed] Ticket;yes]
$sendMessage[Ticket closed and user removed.]
Removal After Resolution
$threadRemoveMember[123456789012345678;$mentioned[1]]
$channelSendMessage[123456789012345678;<@$mentioned[1]> has been removed from the thread.]
Notes
- To add a member, use
$threadAddMember[].
Try it
Paste an example into the playground to preview its message (functions that act on Discord are not run), or build the same thing with blocks.