RESTPatchAPIGuildScheduledEventJSONBody

@see

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

Hierarchy

• _Nullable<Pick<RESTPostAPIGuildScheduledEventJSONBody, description | entity_metadata | recurrence_rule>>
• _StrictPartial<Omit<RESTPostAPIGuildScheduledEventJSONBody, description | entity_metadata | recurrence_rule>>
  • RESTPatchAPIGuildScheduledEventJSONBody

Index

Properties

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

Properties

optionalinheritedchannel_id

channel_id?: _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<undefined | string>

Inherited from _StrictPartial.channel_id

The stage channel id of the guild event

optionalinheriteddescription

description?: null | string

Inherited from _Nullable.description

The description of the guild event

optionalinheritedentity_metadata

entity_metadata?: null | APIGuildScheduledEventEntityMetadata

Inherited from _Nullable.entity_metadata

The entity metadata of the scheduled event

optionalinheritedentity_type

entity_type?: _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<undefined | GuildScheduledEventEntityType>

Inherited from _StrictPartial.entity_type

The scheduled entity type of the guild event

optionalinheritedimage

image?: _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<undefined | null | string>

Inherited from _StrictPartial.image

The cover image of the scheduled event

optionalinheritedname

name?: string

Inherited from _StrictPartial.name

The name of the guild event

optionalinheritedprivacy_level

privacy_level?: GuildScheduledEventPrivacyLevel

Inherited from _StrictPartial.privacy_level

The privacy level of the guild event

optionalinheritedrecurrence_rule

recurrence_rule?: null | APIGuildScheduledEventRecurrenceRule

Inherited from _Nullable.recurrence_rule

The definition for how often this event should recur

optionalinheritedscheduled_end_time

scheduled_end_time?: _AddUndefinedToPossiblyUndefinedPropertiesOfInterface<undefined | string>

Inherited from _StrictPartial.scheduled_end_time

The time when the scheduled event is scheduled to end

optionalinheritedscheduled_start_time

scheduled_start_time?: string

Inherited from _StrictPartial.scheduled_start_time

The time to schedule the guild event at

optionalstatus

status?: GuildScheduledEventStatus

The status of the scheduled event