stage_instances_create
stage_instances_create
Section titled “stage_instances_create”Category: stage_instances
Start a Stage instance (live event in a Stage channel).
When to use
Section titled “When to use”- Begin a public talk/AMA in a stage channel.
When NOT to use
Section titled “When NOT to use”| Field | Type | Required | Description |
|---|---|---|---|
channel_id | string | yes | Stage channel to host the instance |
topic | string | yes | Topic of the stage (1..120 chars) |
privacy_level | integer | no | 1 PUBLIC (deprecated), 2 GUILD_ONLY (default) |
send_start_notification | boolean | no | Notify @everyone that a stage has started |
guild_scheduled_event_id | string | no | Associate with an existing scheduled event |
audit_reason | string | no | Reason recorded in audit log (X-Audit-Log-Reason header) |
Returns
Section titled “Returns”\{id, guild_id, channel_id, topic, privacy_level\}.
Output schema
Section titled “Output schema”| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | Discord stage instance ID |
guild_id | string | yes | |
channel_id | string | yes | Discord channel ID (snowflake) |
topic | string | yes | |
privacy_level | integer | yes |
Annotations
Section titled “Annotations”| Property | Value |
|---|---|
| Read-only | no |
| Destructive | no |
| Idempotent | no |
| Open-world | yes |
| Confirmation required | no |