stage_instances_delete
stage_instances_delete
Section titled “stage_instances_delete”Category: stage_instances
End the live Stage instance for a channel. DESTRUCTIVE — IRREVERSIBLE.
When to use
Section titled “When to use”stop a stage talk.
When NOT to use
Section titled “When NOT to use”| Field | Type | Required | Description |
|---|---|---|---|
channel_id | string | yes | Stage channel whose instance to end |
audit_reason | string | no | Reason recorded in audit log (X-Audit-Log-Reason header) |
Returns
Section titled “Returns”\{deleted, channel_id\}.
Output schema
Section titled “Output schema”| Field | Type | Required | Description |
|---|---|---|---|
deleted | boolean | yes | |
channel_id | string | yes | Discord channel ID (snowflake) |
Annotations
Section titled “Annotations”| Property | Value |
|---|---|
| Read-only | no |
| Destructive | yes |
| Idempotent | yes |
| Open-world | yes |
| Confirmation required | yes (__confirm:true required) |