threads_leave
threads_leave
Section titled “threads_leave”Category: threads
Remove the current bot user from a thread.
When to use
Section titled “When to use”- Bot finished its task in the thread; reduce noise / event fanout.
When NOT to use
Section titled “When NOT to use”- Removing a different user → use
threads_remove_member.
| Field | Type | Required | Description |
|---|---|---|---|
thread_id | string | yes | Thread to leave |
Returns
Section titled “Returns”\{left, thread_id\}. Idempotent.
Output schema
Section titled “Output schema”| Field | Type | Required | Description |
|---|---|---|---|
left | boolean | yes | |
thread_id | string | yes | Discord channel ID (snowflake) |
Annotations
Section titled “Annotations”| Property | Value |
|---|---|
| Read-only | no |
| Destructive | no |
| Idempotent | yes |
| Open-world | yes |
| Confirmation required | no |