Preview environment

interface RESTPostAPIGuildScheduledEventJSONBody

export interface RESTPostAPIGuildScheduledEventJSONBody

See also: https://discord.com/developers/docs/resources/guild-scheduled-event#create-guild-scheduled-event

optional
channel_id? : Snowflake | undefined

The stage channel id of the guild event

optional
description? : string | undefined

The description of the guild event

optional
entity_metadata? : APIGuildScheduledEventEntityMetadata | undefined

The entity metadata of the scheduled event

optional
entity_type? : GuildScheduledEventEntityType | undefined

The scheduled entity type of the guild event

optional
image? : string | null | undefined

The cover image of the scheduled event

name : string

The name of the guild event

privacy_level : GuildScheduledEventPrivacyLevel

The privacy level of the guild event

optional
recurrence_rule? : APIGuildScheduledEventRecurrenceRule | undefined

The definition for how often this event should recur

optional
scheduled_end_time? : string | undefined

The time when the scheduled event is scheduled to end

scheduled_start_time : string

The time to schedule the guild event at