Guild Scheduled Event

A representation of a scheduled event in a guild.

* creator_id will be null and creator will not be included for events created before October 25th, 2021, when the concept of creator_id was introduced and tracked.

** See field requirements by entity type to understand the relationship between entity_type and the following fields: channel_id, entity_metadata, and scheduled_end_time

The following table shows field requirements based on current entity type.

value : This field is required to be a non-null value

null : This field is required to be null

- : No strict requirements

* entity_metadata with a non-null location must be provided

* Once status is set to COMPLETED or CANCELED, the status can no longer be updated

SCHEDULED --> ACTIVE

ACTIVE --------> COMPLETED

SCHEDULED --> CANCELED

* required for events with 'entity_type': EXTERNAL

Discord's recurrence rule is a subset of the behaviors defined in the iCalendar RFC and implemented by python's dateutil rrule

[1] - Cannot be set externally currently.

frequency = 3 // Frequency.DAILY
interval = 1
by_weekday = [0, 1, 2, 3, 4] // [Weekday.MONDAY, ..., Weekday.FRIDAY]

frequency = 2 // Frequency.WEEKLY
interval = 1
by_weekday = [2] // [Weekday.WEDNESDAY]

frequency = 2 // Frequency.WEEKLY
interval = 2
by_weekday = [2] // [Weekday.WEDNESDAY]

frequency = 1 // Frequency.MONTHLY
interval = 1
by_n_weekday = [{
  n: 4,
  day: 2 // Weekday.WEDNESDAY
}]

frequency = 0 // Frequency.YEARLY
interval = 1
by_month = [7] // [Month.JULY]
by_month_day = [24]

/guilds/{guild.id}/scheduled-events

Returns a list of guild scheduled event objects for the given guild.

/guilds/{guild.id}/scheduled-events

Create a guild scheduled event in the guild. Returns a guild scheduled event object on success. Fires a Guild Scheduled Event Create Gateway event.

* Optional for events with 'entity_type': EXTERNAL

** Required for events with 'entity_type': EXTERNAL

/guilds/{guild.id}/scheduled-events/{guild_scheduled_event.id}

Get a guild scheduled event. Returns a guild scheduled event object on success.

/guilds/{guild.id}/scheduled-events/{guild_scheduled_event.id}

Modify a guild scheduled event. Returns the modified guild scheduled event object on success. Fires a Guild Scheduled Event Update Gateway event.

* If updating entity_type to EXTERNAL:

• channel_id is required and must be set to null
• entity_metadata with a location field must be provided
• scheduled_end_time must be provided

/guilds/{guild.id}/scheduled-events/{guild_scheduled_event.id}

Delete a guild scheduled event. Returns a 204 on success. Fires a Guild Scheduled Event Delete Gateway event.

/guilds/{guild.id}/scheduled-events/{guild_scheduled_event.id}/users

Get a list of guild scheduled event users subscribed to a guild scheduled event. Returns a list of guild scheduled event user objects on success. Guild member data, if it exists, is included if the with_member query parameter is set.

* Provide a user id to before and after for pagination. Users will always be returned in ascending order by user_id. If both before and after are provided, only before is respected. Fetching users in-between before and after is not supported.

NOTE: status and entity_type here are expressed by name rather than their value for readability

When an event with 'status': ACTIVE and 'entity_type': STAGE_INSTANCE has no users connected to the stage channel for a certain period of time (on the order of minutes), the event status will be automatically set to COMPLETED.

When an event with 'status': ACTIVE and 'entity_type': VOICE has no users connected to the voice channel for a certain period of time (on the order of minutes), the event status will be automatically set to COMPLETED.

An event with 'entity_type': EXTERNAL at its scheduled_start_time will automatically have status set to ACTIVE.

An event with 'entity_type': EXTERNAL at its scheduled_end_time will automatically have status set to COMPLETED.

Any event with 'status': SCHEDULED after a certain time interval (on the order of hours) beyond its scheduled_start_time will have its status automatically set to CANCELLED.

NOTE: entity_type is expressed by name rather than value for readability

The computed permissions for the user in the channel_id associated with the event must include:

• VIEW_CHANNEL

• CREATE_EVENTS
• MANAGE_CHANNELS
• MUTE_MEMBERS
• MOVE_MEMBERS

• If the event was created by the current user, either CREATE_EVENTS or MANAGE_EVENTS. Otherwise, MANAGE_EVENTS
• MANAGE_CHANNELS
• MUTE_MEMBERS
• MOVE_MEMBERS

The computed permissions for the user in the channel_id associated with the event must include:

• VIEW_CHANNEL

• CREATE_EVENTS
• VIEW_CHANNEL
• CONNECT

• If the event was created by the current user, either CREATE_EVENTS or MANAGE_EVENTS. Otherwise, MANAGE_EVENTS
• VIEW_CHANNEL
• CONNECT

The user's guild-level permissions must include:

• No permissions required

• CREATE_EVENTS

• If the event was created by the current user, either CREATE_EVENTS or MANAGE_EVENTS. Otherwise, MANAGE_EVENTS