Guild Scheduled Event Resource

Scheduled events are a way to plan and organize events in a guild. They can be associated with a stage channel, voice channel, or an external location.

¹ 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.

{
  "id": "1059954443799498922",
  "guild_id": "1046920999469330512",
  "channel_id": null,
  "creator_id": "787017887877169173",
  "name": "Alien meetup",
  "description": "Aliens only!",
  "image": "4b07ee3046773e8f2c8be856a70bd1a7",
  "scheduled_start_time": "2023-12-31T23:00:00+00:00",
  "scheduled_end_time": "2024-01-01T23:00:00+00:00",
  "privacy_level": 2,
  "status": 1,
  "entity_type": 3,
  "entity_id": null,
  "entity_metadata": {
    "location": "somwhere in ocean"
  },
  "sku_ids": [],
  "creator": {
    "id": "787017887877169173",
    "username": "dziurwa",
    "global_name": "Dziurwa",
    "avatar": "cff3479a14360e4223f151eb8ad63dec",
    "discriminator": "0",
    "public_flags": 4194560,
    "avatar_decoration_data": null
  },
  "user_count": 7
}

¹ Required for events with an entity_type of EXTERNAL.

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

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

Returns an array of subscribed guild scheduled event user objects for the current user for a given guild.

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

Gets a guild scheduled event. Returns a guild scheduled event object.

Creates 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 an entity_type of EXTERNAL.

² Required for events with an entity_type of EXTERNAL.

Modifies 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

² Only the following are valid status changes:

• SCHEDULED --> ACTIVE
• ACTIVE --> COMPLETED
• SCHEDULED --> CANCELED

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

Gets a list of users subscribed to a guild scheduled event.

Subscribes the current user to a guild scheduled event. Returns a subscribed guild scheduled event user object on success. Fires a Guild Scheduled Event User Add Gateway event.

Unsubscribes the current user from a guild scheduled event. Returns a 204 empty response on success. Fires a Guild Scheduled Event User Remove Gateway event.

When an event with a status of ACTIVE and entity_type of 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 a status of ACTIVE and entity_type of 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 an entity_type of EXTERNAL at its scheduled_start_time will automatically have status set to ACTIVE.

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

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

• MANAGE_EVENTS at the guild level or at least MANAGE_EVENTS for the channel_id associated with the event
• MANAGE_CHANNELS
• MUTE_MEMBERS
• MOVE_MEMBERS

• VIEW_CHANNEL for channel_id associated with the event

• MANAGE_EVENTS at the guild level or MANAGE_EVENTS for the channel_id associated with the event
• VIEW_CHANNEL for channel_id associated with event
• CONNECT for channel_id associated with event

• VIEW_CHANNEL for channel_id associated with the event

• MANAGE_EVENTS at the guild level

• No other permissions required