Skip to content

RESTPatchAPIGuildScheduledEventJSONBody

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

Signature

export interface RESTPatchAPIGuildScheduledEventJSONBody extends StrictPartial<Omit<RESTPostAPIGuildScheduledEventJSONBody, 'channel_id' | 'entity_metadata' | 'description' | 'recurrence_rule'>>

Properties

channel_id?: Snowflake | null | undefined;

The channel id in which the scheduled event will be hosted, or `null` when moving to `EXTERNAL`. https://docs.discord.com/developers/resources/guild-scheduled-event#modify-guild-scheduled-event-json-params

entity_metadata?: APIGuildScheduledEventEntityMetadata | null | undefined;

The entity metadata of the scheduled event. Discord silently discards this field for non-`EXTERNAL` events. https://docs.discord.com/developers/resources/guild-scheduled-event#modify-guild-scheduled-event-json-params

description?: string | null | undefined;

The description of the guild event. https://docs.discord.com/developers/resources/guild-scheduled-event#modify-guild-scheduled-event-json-params

recurrence_rule?: APIGuildScheduledEventRecurrenceRule | null | undefined;

The definition for how often this event should recur, or `null` to clear it. https://docs.discord.com/developers/resources/guild-scheduled-event#modify-guild-scheduled-event-json-params