threads_remove_member
threads_remove_member
Section titled “threads_remove_member”Category: threads
Remove a guild user from a thread.
When to use
Section titled “When to use”- Drop a user out of a private thread; thread cleanup.
When NOT to use
Section titled “When NOT to use”- Removing the bot itself → use
threads_leave.
| Field | Type | Required | Description |
|---|---|---|---|
thread_id | string | yes | Thread to remove from |
user_id | string | yes | User to remove |
Returns
Section titled “Returns”\{removed, thread_id, user_id\}.
Output schema
Section titled “Output schema”| Field | Type | Required | Description |
|---|---|---|---|
removed | boolean | yes | |
thread_id | string | yes | Discord channel ID (snowflake) |
user_id | string | yes | Discord user ID |
Annotations
Section titled “Annotations”| Property | Value |
|---|---|
| Read-only | no |
| Destructive | no |
| Idempotent | yes |
| Open-world | yes |
| Confirmation required | no |