Interface RESTPostAPIGuildScheduledEventJSONBody

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

Hierarchy

  • RESTPostAPIGuildScheduledEventJSONBody

Properties

channel_id? description? entity_metadata? entity_type? image? name privacy_level recurrence_rule? scheduled_end_time? scheduled_start_time

Properties

Optional channel_id

channel_id?: string

The stage channel id of the guild event

Optional description

description?: string

The description of the guild event

Optional entity_metadata

entity_metadata?: APIGuildScheduledEventEntityMetadata

The entity metadata of the scheduled event

Optional entity_type

entity_type?: GuildScheduledEventEntityType

The scheduled entity type of the guild event

Optional image

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

Optional recurrence_rule

recurrence_rule?: APIGuildScheduledEventRecurrenceRule

The definition for how often this event should recur

Optional scheduled_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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc