RESTPostAPIGuildScheduledEventJSONBody

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

@deprecated

API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.

Index

Properties

• channel_id
• description
• entity_metadata
• entity_type
• image
• name
• privacy_level
• scheduled_end_time
• scheduled_start_time

Properties

optionalchannel_id

channel_id?: string

The stage channel id of the guild event

optionaldescription

description?: string

The description of the guild event

optionalentity_metadata

entity_metadata?: APIGuildScheduledEventEntityMetadata

The entity metadata of the scheduled event

optionalentity_type

entity_type?: GuildScheduledEventEntityType

The scheduled entity type of the guild event

optionalimage

image?: null | string

The cover image of the scheduled event

name

name: string

The name of the guild event

privacy_level

privacy_level: GuildOnly

The privacy level of the guild event

optionalscheduled_end_time

scheduled_end_time?: string

The time when the scheduled event is scheduled to end

scheduled_start_time

scheduled_start_time: string

The time to schedule the guild event at