From a31fcbd9605f2b0a1aa694cb9ca029c175683ce4 Mon Sep 17 00:00:00 2001 From: Droid <174426320+Droid00000@users.noreply.github.com> Date: Sun, 30 Nov 2025 17:35:25 -0500 Subject: [PATCH 1/4] Droid - Document Guild Scheduled Event Exceptions --- docs/events/gateway-events.mdx | 200 ++++++++++++----------- docs/events/gateway.mdx | 3 + docs/resources/audit-log.mdx | 3 + docs/resources/guild-scheduled-event.mdx | 167 ++++++++++++++++--- 4 files changed, 257 insertions(+), 116 deletions(-) diff --git a/docs/events/gateway-events.mdx b/docs/events/gateway-events.mdx index 406873837e..f2b42abb6d 100644 --- a/docs/events/gateway-events.mdx +++ b/docs/events/gateway-events.mdx @@ -304,87 +304,91 @@ Sent by the client to indicate a presence or status update. Receive events are Gateway events encapsulated in an [event payload](/docs/events/gateway-events#payload-structure), and are sent by Discord to an app through a Gateway connection. Receive events correspond to events that happen in a Discord server where the app is installed. -| Name | Description | -|--------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------| -| [Hello](/docs/events/gateway-events#hello) | Defines the heartbeat interval | -| [Ready](/docs/events/gateway-events#ready) | Contains the initial state information | -| [Resumed](/docs/events/gateway-events#resumed) | Response to [Resume](/docs/events/gateway-events#resume) | -| [Reconnect](/docs/events/gateway-events#reconnect) | Server is going away, client should reconnect to gateway and resume | -| [Rate Limited](/docs/events/gateway-events#rate-limited) | Application was rate limited for a gateway opcode | -| [Invalid Session](/docs/events/gateway-events#invalid-session) | Failure response to [Identify](/docs/events/gateway-events#identify) or [Resume](/docs/events/gateway-events#resume) or invalid active session | -| [Application Command Permissions Update](/docs/events/gateway-events#application-command-permissions-update) | Application command permission was updated | -| [Auto Moderation Rule Create](/docs/events/gateway-events#auto-moderation-rule-create) | Auto Moderation rule was created | -| [Auto Moderation Rule Update](/docs/events/gateway-events#auto-moderation-rule-update) | Auto Moderation rule was updated | -| [Auto Moderation Rule Delete](/docs/events/gateway-events#auto-moderation-rule-delete) | Auto Moderation rule was deleted | -| [Auto Moderation Action Execution](/docs/events/gateway-events#auto-moderation-action-execution) | Auto Moderation rule was triggered and an action was executed (e.g. a message was blocked) | -| [Channel Create](/docs/events/gateway-events#channel-create) | New guild channel created | -| [Channel Update](/docs/events/gateway-events#channel-update) | Channel was updated | -| [Channel Delete](/docs/events/gateway-events#channel-delete) | Channel was deleted | -| [Channel Pins Update](/docs/events/gateway-events#channel-pins-update) | Message was pinned or unpinned | -| [Thread Create](/docs/events/gateway-events#thread-create) | Thread created, also sent when being added to a private thread | -| [Thread Update](/docs/events/gateway-events#thread-update) | Thread was updated | -| [Thread Delete](/docs/events/gateway-events#thread-delete) | Thread was deleted | -| [Thread List Sync](/docs/events/gateway-events#thread-list-sync) | Sent when gaining access to a channel, contains all active threads in that channel | -| [Thread Member Update](/docs/events/gateway-events#thread-member-update) | [Thread member](/docs/resources/channel#thread-member-object) for the current user was updated | -| [Thread Members Update](/docs/events/gateway-events#thread-members-update) | Some user(s) were added to or removed from a thread | -| [Entitlement Create](/docs/events/gateway-events#entitlement-create) | Entitlement was created | -| [Entitlement Update](/docs/events/gateway-events#entitlement-update) | Entitlement was updated or renewed | -| [Entitlement Delete](/docs/events/gateway-events#entitlement-delete) | Entitlement was deleted | -| [Guild Create](/docs/events/gateway-events#guild-create) | Lazy-load for unavailable guild, guild became available, or user joined a new guild | -| [Guild Update](/docs/events/gateway-events#guild-update) | Guild was updated | -| [Guild Delete](/docs/events/gateway-events#guild-delete) | Guild became unavailable, or user left/was removed from a guild | -| [Guild Audit Log Entry Create](/docs/events/gateway-events#guild-audit-log-entry-create) | A guild audit log entry was created | -| [Guild Ban Add](/docs/events/gateway-events#guild-ban-add) | User was banned from a guild | -| [Guild Ban Remove](/docs/events/gateway-events#guild-ban-remove) | User was unbanned from a guild | -| [Guild Emojis Update](/docs/events/gateway-events#guild-emojis-update) | Guild emojis were updated | -| [Guild Stickers Update](/docs/events/gateway-events#guild-stickers-update) | Guild stickers were updated | -| [Guild Integrations Update](/docs/events/gateway-events#guild-integrations-update) | Guild integration was updated | -| [Guild Member Add](/docs/events/gateway-events#guild-member-add) | New user joined a guild | -| [Guild Member Remove](/docs/events/gateway-events#guild-member-remove) | User was removed from a guild | -| [Guild Member Update](/docs/events/gateway-events#guild-member-update) | Guild member was updated | -| [Guild Members Chunk](/docs/events/gateway-events#guild-members-chunk) | Response to [Request Guild Members](/docs/events/gateway-events#request-guild-members) | -| [Guild Role Create](/docs/events/gateway-events#guild-role-create) | Guild role was created | -| [Guild Role Update](/docs/events/gateway-events#guild-role-update) | Guild role was updated | -| [Guild Role Delete](/docs/events/gateway-events#guild-role-delete) | Guild role was deleted | -| [Guild Scheduled Event Create](/docs/events/gateway-events#guild-scheduled-event-create) | Guild scheduled event was created | -| [Guild Scheduled Event Update](/docs/events/gateway-events#guild-scheduled-event-update) | Guild scheduled event was updated | -| [Guild Scheduled Event Delete](/docs/events/gateway-events#guild-scheduled-event-delete) | Guild scheduled event was deleted | -| [Guild Scheduled Event User Add](/docs/events/gateway-events#guild-scheduled-event-user-add) | User subscribed to a guild scheduled event | -| [Guild Scheduled Event User Remove](/docs/events/gateway-events#guild-scheduled-event-user-remove) | User unsubscribed from a guild scheduled event | -| [Guild Soundboard Sound Create](/docs/events/gateway-events#guild-soundboard-sound-create) | Guild soundboard sound was created | -| [Guild Soundboard Sound Update](/docs/events/gateway-events#guild-soundboard-sound-update) | Guild soundboard sound was updated | -| [Guild Soundboard Sound Delete](/docs/events/gateway-events#guild-soundboard-sound-delete) | Guild soundboard sound was deleted | -| [Guild Soundboard Sounds Update](/docs/events/gateway-events#guild-soundboard-sounds-update) | Guild soundboard sounds were updated | -| [Soundboard Sounds](/docs/events/gateway-events#soundboard-sounds) | Response to [Request Soundboard Sounds](/docs/events/gateway-events#request-soundboard-sounds) | -| [Integration Create](/docs/events/gateway-events#integration-create) | Guild integration was created | -| [Integration Update](/docs/events/gateway-events#integration-update) | Guild integration was updated | -| [Integration Delete](/docs/events/gateway-events#integration-delete) | Guild integration was deleted | -| [Interaction Create](/docs/events/gateway-events#interaction-create) | User used an interaction, such as an [Application Command](/docs/interactions/application-commands) | -| [Invite Create](/docs/events/gateway-events#invite-create) | Invite to a channel was created | -| [Invite Delete](/docs/events/gateway-events#invite-delete) | Invite to a channel was deleted | -| [Message Create](/docs/events/gateway-events#message-create) | Message was created | -| [Message Update](/docs/events/gateway-events#message-update) | Message was edited | -| [Message Delete](/docs/events/gateway-events#message-delete) | Message was deleted | -| [Message Delete Bulk](/docs/events/gateway-events#message-delete-bulk) | Multiple messages were deleted at once | -| [Message Reaction Add](/docs/events/gateway-events#message-reaction-add) | User reacted to a message | -| [Message Reaction Remove](/docs/events/gateway-events#message-reaction-remove) | User removed a reaction from a message | -| [Message Reaction Remove All](/docs/events/gateway-events#message-reaction-remove-all) | All reactions were explicitly removed from a message | -| [Message Reaction Remove Emoji](/docs/events/gateway-events#message-reaction-remove-emoji) | All reactions for a given emoji were explicitly removed from a message | -| [Presence Update](/docs/events/gateway-events#presence-update) | User was updated | -| [Stage Instance Create](/docs/events/gateway-events#stage-instance-create) | Stage instance was created | -| [Stage Instance Update](/docs/events/gateway-events#stage-instance-update) | Stage instance was updated | -| [Stage Instance Delete](/docs/events/gateway-events#stage-instance-delete) | Stage instance was deleted or closed | -| [Subscription Create](/docs/events/gateway-events#subscription-create) | Premium App Subscription was created | -| [Subscription Update](/docs/events/gateway-events#subscription-update) | Premium App Subscription was updated | -| [Subscription Delete](/docs/events/gateway-events#subscription-delete) | Premium App Subscription was deleted | -| [Typing Start](/docs/events/gateway-events#typing-start) | User started typing in a channel | -| [User Update](/docs/events/gateway-events#user-update) | Properties about the user changed | -| [Voice Channel Effect Send](/docs/events/gateway-events#voice-channel-effect-send) | Someone sent an effect in a voice channel the current user is connected to | -| [Voice State Update](/docs/events/gateway-events#voice-state-update) | Someone joined, left, or moved a voice channel | -| [Voice Server Update](/docs/events/gateway-events#voice-server-update) | Guild's voice server was updated | -| [Webhooks Update](/docs/events/gateway-events#webhooks-update) | Guild channel webhook was created, update, or deleted | -| [Message Poll Vote Add](/docs/events/gateway-events#message-poll-vote-add) | User voted on a poll | -| [Message Poll Vote Remove](/docs/events/gateway-events#message-poll-vote-remove) | User removed a vote on a poll | +| Name | Description | +|----------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------| +| [Hello](/docs/events/gateway-events#hello) | Defines the heartbeat interval | +| [Ready](/docs/events/gateway-events#ready) | Contains the initial state information | +| [Resumed](/docs/events/gateway-events#resumed) | Response to [Resume](/docs/events/gateway-events#resume) | +| [Reconnect](/docs/events/gateway-events#reconnect) | Server is going away, client should reconnect to gateway and resume | +| [Rate Limited](/docs/events/gateway-events#rate-limited) | Application was rate limited for a gateway opcode | +| [Invalid Session](/docs/events/gateway-events#invalid-session) | Failure response to [Identify](/docs/events/gateway-events#identify) or [Resume](/docs/events/gateway-events#resume) or invalid active session | +| [Application Command Permissions Update](/docs/events/gateway-events#application-command-permissions-update) | Application command permission was updated | +| [Auto Moderation Rule Create](/docs/events/gateway-events#auto-moderation-rule-create) | Auto Moderation rule was created | +| [Auto Moderation Rule Update](/docs/events/gateway-events#auto-moderation-rule-update) | Auto Moderation rule was updated | +| [Auto Moderation Rule Delete](/docs/events/gateway-events#auto-moderation-rule-delete) | Auto Moderation rule was deleted | +| [Auto Moderation Action Execution](/docs/events/gateway-events#auto-moderation-action-execution) | Auto Moderation rule was triggered and an action was executed (e.g. a message was blocked) | +| [Channel Create](/docs/events/gateway-events#channel-create) | New guild channel created | +| [Channel Update](/docs/events/gateway-events#channel-update) | Channel was updated | +| [Channel Delete](/docs/events/gateway-events#channel-delete) | Channel was deleted | +| [Channel Pins Update](/docs/events/gateway-events#channel-pins-update) | Message was pinned or unpinned | +| [Thread Create](/docs/events/gateway-events#thread-create) | Thread created, also sent when being added to a private thread | +| [Thread Update](/docs/events/gateway-events#thread-update) | Thread was updated | +| [Thread Delete](/docs/events/gateway-events#thread-delete) | Thread was deleted | +| [Thread List Sync](/docs/events/gateway-events#thread-list-sync) | Sent when gaining access to a channel, contains all active threads in that channel | +| [Thread Member Update](/docs/events/gateway-events#thread-member-update) | [Thread member](/docs/resources/channel#thread-member-object) for the current user was updated | +| [Thread Members Update](/docs/events/gateway-events#thread-members-update) | Some user(s) were added to or removed from a thread | +| [Entitlement Create](/docs/events/gateway-events#entitlement-create) | Entitlement was created | +| [Entitlement Update](/docs/events/gateway-events#entitlement-update) | Entitlement was updated or renewed | +| [Entitlement Delete](/docs/events/gateway-events#entitlement-delete) | Entitlement was deleted | +| [Guild Create](/docs/events/gateway-events#guild-create) | Lazy-load for unavailable guild, guild became available, or user joined a new guild | +| [Guild Update](/docs/events/gateway-events#guild-update) | Guild was updated | +| [Guild Delete](/docs/events/gateway-events#guild-delete) | Guild became unavailable, or user left/was removed from a guild | +| [Guild Audit Log Entry Create](/docs/events/gateway-events#guild-audit-log-entry-create) | A guild audit log entry was created | +| [Guild Ban Add](/docs/events/gateway-events#guild-ban-add) | User was banned from a guild | +| [Guild Ban Remove](/docs/events/gateway-events#guild-ban-remove) | User was unbanned from a guild | +| [Guild Emojis Update](/docs/events/gateway-events#guild-emojis-update) | Guild emojis were updated | +| [Guild Stickers Update](/docs/events/gateway-events#guild-stickers-update) | Guild stickers were updated | +| [Guild Integrations Update](/docs/events/gateway-events#guild-integrations-update) | Guild integration was updated | +| [Guild Member Add](/docs/events/gateway-events#guild-member-add) | New user joined a guild | +| [Guild Member Remove](/docs/events/gateway-events#guild-member-remove) | User was removed from a guild | +| [Guild Member Update](/docs/events/gateway-events#guild-member-update) | Guild member was updated | +| [Guild Members Chunk](/docs/events/gateway-events#guild-members-chunk) | Response to [Request Guild Members](/docs/events/gateway-events#request-guild-members) | +| [Guild Role Create](/docs/events/gateway-events#guild-role-create) | Guild role was created | +| [Guild Role Update](/docs/events/gateway-events#guild-role-update) | Guild role was updated | +| [Guild Role Delete](/docs/events/gateway-events#guild-role-delete) | Guild role was deleted | +| [Guild Scheduled Event Create](/docs/events/gateway-events#guild-scheduled-event-create) | Guild scheduled event was created | +| [Guild Scheduled Event Update](/docs/events/gateway-events#guild-scheduled-event-update) | Guild scheduled event was updated | +| [Guild Scheduled Event Delete](/docs/events/gateway-events#guild-scheduled-event-delete) | Guild scheduled event was deleted | +| [Guild Scheduled Event User Add](/docs/events/gateway-events#guild-scheduled-event-user-add) | User subscribed to a guild scheduled event | +| [Guild Scheduled Event User Remove](/docs/events/gateway-events#guild-scheduled-event-user-remove) | User unsubscribed from a guild scheduled event | +| [Guild Soundboard Sound Create](/docs/events/gateway-events#guild-soundboard-sound-create) | Guild soundboard sound was created | +| [Guild Soundboard Sound Update](/docs/events/gateway-events#guild-soundboard-sound-update) | Guild soundboard sound was updated | +| [Guild Soundboard Sound Delete](/docs/events/gateway-events#guild-soundboard-sound-delete) | Guild soundboard sound was deleted | +| [Guild Soundboard Sounds Update](/docs/events/gateway-events#guild-soundboard-sounds-update) | Guild soundboard sounds were updated | +| [Soundboard Sounds](/docs/events/gateway-events#soundboard-sounds) | Response to [Request Soundboard Sounds](/docs/events/gateway-events#request-soundboard-sounds) | +| [Integration Create](/docs/events/gateway-events#integration-create) | Guild integration was created | +| [Integration Update](/docs/events/gateway-events#integration-update) | Guild integration was updated | +| [Integration Delete](/docs/events/gateway-events#integration-delete) | Guild integration was deleted | +| [Interaction Create](/docs/events/gateway-events#interaction-create) | User used an interaction, such as an [Application Command](/docs/interactions/application-commands) | +| [Invite Create](/docs/events/gateway-events#invite-create) | Invite to a channel was created | +| [Invite Delete](/docs/events/gateway-events#invite-delete) | Invite to a channel was deleted | +| [Message Create](/docs/events/gateway-events#message-create) | Message was created | +| [Message Update](/docs/events/gateway-events#message-update) | Message was edited | +| [Message Delete](/docs/events/gateway-events#message-delete) | Message was deleted | +| [Message Delete Bulk](/docs/events/gateway-events#message-delete-bulk) | Multiple messages were deleted at once | +| [Message Reaction Add](/docs/events/gateway-events#message-reaction-add) | User reacted to a message | +| [Message Reaction Remove](/docs/events/gateway-events#message-reaction-remove) | User removed a reaction from a message | +| [Message Reaction Remove All](/docs/events/gateway-events#message-reaction-remove-all) | All reactions were explicitly removed from a message | +| [Message Reaction Remove Emoji](/docs/events/gateway-events#message-reaction-remove-emoji) | All reactions for a given emoji were explicitly removed from a message | +| [Presence Update](/docs/events/gateway-events#presence-update) | User was updated | +| [Stage Instance Create](/docs/events/gateway-events#stage-instance-create) | Stage instance was created | +| [Stage Instance Update](/docs/events/gateway-events#stage-instance-update) | Stage instance was updated | +| [Stage Instance Delete](/docs/events/gateway-events#stage-instance-delete) | Stage instance was deleted or closed | +| [Subscription Create](/docs/events/gateway-events#subscription-create) | Premium App Subscription was created | +| [Subscription Update](/docs/events/gateway-events#subscription-update) | Premium App Subscription was updated | +| [Subscription Delete](/docs/events/gateway-events#subscription-delete) | Premium App Subscription was deleted | +| [Typing Start](/docs/events/gateway-events#typing-start) | User started typing in a channel | +| [User Update](/docs/events/gateway-events#user-update) | Properties about the user changed | +| [Voice Channel Effect Send](/docs/events/gateway-events#voice-channel-effect-send) | Someone sent an effect in a voice channel the current user is connected to | +| [Voice State Update](/docs/events/gateway-events#voice-state-update) | Someone joined, left, or moved a voice channel | +| [Voice Server Update](/docs/events/gateway-events#voice-server-update) | Guild's voice server was updated | +| [Webhooks Update](/docs/events/gateway-events#webhooks-update) | Guild channel webhook was created, update, or deleted | +| [Message Poll Vote Add](/docs/events/gateway-events#message-poll-vote-add) | User voted on a poll | +| [Message Poll Vote Remove](/docs/events/gateway-events#message-poll-vote-remove) | User removed a vote on a poll | +| [Guild Scheduled Event Exception Create](/docs/events/gateway-events#guild-scheduled-event-exception-create) | Guild scheduled event exception was created | +| [Guild Scheduled Event Exception Update](/docs/events/gateway-events#guild-scheduled-event-exception-update) | Guild scheduled event exception was updated | +| [Guild Scheduled Event Exception Delete](/docs/events/gateway-events#guild-scheduled-event-exception-delete) | Guild scheduled event exception was deleted | +| [Guild Scheduled Event Exceptions Delete](/docs/events/gateway-events#guild-scheduled-event-exceptions-delete) | All of the exceptions for a guild scheduled event were deleted | #### Hello @@ -860,11 +864,12 @@ Sent when a user has subscribed to a guild scheduled event. ###### Guild Scheduled Event User Add Event Fields -| Field | Type | Description | -|--------------------------|-----------|---------------------------------| -| guild_scheduled_event_id | snowflake | ID of the guild scheduled event | -| user_id | snowflake | ID of the user | -| guild_id | snowflake | ID of the guild | +| Field | Type | Description | +|-------------------------------------|-----------|----------------------------------------------------------| +| guild_scheduled_event_id | snowflake | ID of the guild scheduled event | +| user_id | snowflake | ID of the user | +| guild_id | snowflake | ID of the guild | +| guild_scheduled_event_exception_id? | snowflake | ID of the guild scheduled event exception, if applicable | #### Guild Scheduled Event User Remove @@ -872,11 +877,24 @@ Sent when a user has unsubscribed from a guild scheduled event. ###### Guild Scheduled Event User Remove Event Fields -| Field | Type | Description | -|--------------------------|-----------|---------------------------------| -| guild_scheduled_event_id | snowflake | ID of the guild scheduled event | -| user_id | snowflake | ID of the user | -| guild_id | snowflake | ID of the guild | +| Field | Type | Description | +|-------------------------------------|-----------|----------------------------------------------------------| +| guild_scheduled_event_id | snowflake | ID of the guild scheduled event | +| user_id | snowflake | ID of the user | +| guild_id | snowflake | ID of the guild | +| guild_scheduled_event_exception_id? | snowflake | ID of the guild scheduled event exception, if applicable | + +#### Guild Scheduled Event Exception Create + +Sent when a guild scheduled event exception is created. The inner payload is a [guild scheduled event exception](/docs/resources/guild-scheduled-event#guild-scheduled-event-exception-object) object with an extra `guild_id` key. + +#### Guild Scheduled Event Exception Update + +Sent when a guild scheduled event exception is updated. The inner payload is a [guild scheduled event exception](/docs/resources/guild-scheduled-event#guild-scheduled-event-exception-object) object with an extra `guild_id` key. + +#### Guild Scheduled Event Exception Delete + +Sent when a guild scheduled event exception is deleted. The inner payload is a [guild scheduled event exception](/docs/resources/guild-scheduled-event#guild-scheduled-event-exception-object) object with an extra `guild_id` key. #### Guild Soundboard Sound Create diff --git a/docs/events/gateway.mdx b/docs/events/gateway.mdx index dfc338ae66..f3a23ffc4e 100644 --- a/docs/events/gateway.mdx +++ b/docs/events/gateway.mdx @@ -400,6 +400,9 @@ GUILD_SCHEDULED_EVENTS (1 << 16) - GUILD_SCHEDULED_EVENT_DELETE - GUILD_SCHEDULED_EVENT_USER_ADD - GUILD_SCHEDULED_EVENT_USER_REMOVE + - GUILD_SCHEDULED_EVENT_EXCEPTION_CREATE + - GUILD_SCHEDULED_EVENT_EXCEPTION_UPDATE + - GUILD_SCHEDULED_EVENT_EXCEPTION_DELETE AUTO_MODERATION_CONFIGURATION (1 << 20) - AUTO_MODERATION_RULE_CREATE diff --git a/docs/resources/audit-log.mdx b/docs/resources/audit-log.mdx index c111cd472c..ca76db6a8b 100644 --- a/docs/resources/audit-log.mdx +++ b/docs/resources/audit-log.mdx @@ -147,6 +147,9 @@ You should assume that your app may run into any field for the changed object, t | ONBOARDING_UPDATE | 167 | Guild Onboarding was updated | [Guild Onboarding](/docs/resources/guild#guild-onboarding-object) | | HOME_SETTINGS_CREATE | 190 | Guild Server Guide was created | | | HOME_SETTINGS_UPDATE | 191 | Guild Server Guide was updated | | +| GUILD_SCHEDULED_EVENT_EXCEPTION_CREATE | 200 | Guild Scheduled Event Exception was created | [Guild Scheduled Event Exception](/docs/resources/guild-scheduled-event#guild-scheduled-event-exception-object) | +| GUILD_SCHEDULED_EVENT_EXCEPTION_UPDATE | 201 | Guild Scheduled Event Exception was updated | [Guild Scheduled Event Exception](/docs/resources/guild-scheduled-event#guild-scheduled-event-exception-object) | +| GUILD_SCHEDULED_EVENT_EXCEPTION_DELETE | 202 | Guild Scheduled Event Exception was deleted | [Guild Scheduled Event Exception](/docs/resources/guild-scheduled-event#guild-scheduled-event-exception-object) | \* Object has exception(s) to available keys. See the [exceptions](/docs/resources/audit-log#audit-log-change-object-audit-log-change-exceptions) section below for details. diff --git a/docs/resources/guild-scheduled-event.mdx b/docs/resources/guild-scheduled-event.mdx index 20a1f8612c..fd299cd7df 100644 --- a/docs/resources/guild-scheduled-event.mdx +++ b/docs/resources/guild-scheduled-event.mdx @@ -6,26 +6,26 @@ A representation of a scheduled event in a [guild](/docs/resources/guild). ###### Guild Scheduled Event Structure -| Field | Type | Description | -|-----------------------|--------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| id | snowflake | the id of the scheduled event | -| guild_id | snowflake | the guild id which the scheduled event belongs to | -| channel_id ** | ?snowflake | the channel id in which the scheduled event will be hosted, or `null` if [scheduled entity type](/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-entity-types) is `EXTERNAL` | -| creator_id? * | ?snowflake | the id of the user that created the scheduled event * | -| name | string | the name of the scheduled event (1-100 characters) | -| description? | ?string | the description of the scheduled event (1-1000 characters) | -| scheduled_start_time | ISO8601 timestamp | the time the scheduled event will start | -| scheduled_end_time ** | ?ISO8601 timestamp | the time the scheduled event will end, required if entity_type is `EXTERNAL` | -| privacy_level | [privacy level](/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-privacy-level) | the privacy level of the scheduled event | -| status | [event status](/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-status) | the status of the scheduled event | -| entity_type | [scheduled entity type](/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-entity-types) | the type of the scheduled event | -| entity_id | ?snowflake | the id of an entity associated with a guild scheduled event | -| entity_metadata ** | ?[entity metadata](/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-entity-metadata) | additional metadata for the guild scheduled event | -| creator? | [user](/docs/resources/user#user-object) object | the user that created the scheduled event | -| user_count? | integer | the number of users subscribed to the scheduled event | -| image? | ?string | the [cover image hash](/docs/reference#image-formatting) of the scheduled event | -| recurrence_rule | ?[recurrence rule](/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object) | the definition for how often this event should recur | - +| Field | Type | Description | +|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| id | snowflake | the id of the scheduled event | +| guild_id | snowflake | the guild id which the scheduled event belongs to | +| channel_id ** | ?snowflake | the channel id in which the scheduled event will be hosted, or `null` if [scheduled entity type](/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-entity-types) is `EXTERNAL` | +| creator_id? * | ?snowflake | the id of the user that created the scheduled event * | +| name | string | the name of the scheduled event (1-100 characters) | +| description? | ?string | the description of the scheduled event (1-1000 characters) | +| scheduled_start_time | ISO8601 timestamp | the time the scheduled event will start | +| scheduled_end_time ** | ?ISO8601 timestamp | the time the scheduled event will end, required if entity_type is `EXTERNAL` | +| privacy_level | [privacy level](/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-privacy-level) | the privacy level of the scheduled event | +| status | [event status](/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-status) | the status of the scheduled event | +| entity_type | [scheduled entity type](/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-entity-types) | the type of the scheduled event | +| entity_id | ?snowflake | the id of an entity associated with a guild scheduled event | +| entity_metadata ** | ?[entity metadata](/docs/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-entity-metadata) | additional metadata for the guild scheduled event | +| creator? | [user](/docs/resources/user#user-object) object | the user that created the scheduled event | +| user_count? | integer | the number of users subscribed to the scheduled event | +| image? | ?string | the [cover image hash](/docs/reference#image-formatting) of the scheduled event | +| recurrence_rule | ?[recurrence rule](/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object) | the definition for how often this event should recur | +| guild_scheduled_event_exceptions | array of [guild scheduled event exception](/docs/resources/guild-scheduled-event#guild-scheduled-event-exception-object) objects | the exceptions to the recurrence rule of the guild scheduled event | \* `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. @@ -96,11 +96,12 @@ SCHEDULED --> CANCELED ###### Guild Scheduled Event User Structure -| Field | Type | Description | -|--------------------------|-----------------------------------------------------------|-----------------------------------------------------------------------------------| -| guild_scheduled_event_id | snowflake | the scheduled event id which the user subscribed to | -| user | [user](/docs/resources/user#user-object) | user which subscribed to an event | -| member? | [guild member](/docs/resources/guild#guild-member-object) | guild member data for this user for the guild which this event belongs to, if any | +| Field | Type | Description | +| ----------------------------------- | --------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| guild_scheduled_event_id | snowflake | the scheduled event id which the user subscribed to | +| user | [user](/docs/resources/user#user-object) | user which subscribed to an event | +| member? | [guild member](/docs/resources/guild#guild-member-object) | guild member data for this user for the guild which this event belongs to, if any | +| guild_scheduled_event_exception_id? | snowflake | the id of the specific scheduled event exception which the user is subscribed to, if any | ### Guild Scheduled Event Recurrence Rule Object Discord's recurrence rule is a subset of the behaviors [defined in the iCalendar RFC](https://datatracker.ietf.org/doc/html/rfc5545) and implemented by [python's dateutil rrule](https://dateutil.readthedocs.io/en/stable/rrule.html) @@ -260,6 +261,21 @@ by_month_day = [24] | NOVEMBER | 11 | | DECEMBER | 12 | +### Guild Scheduled Event Exception Object +A guild scheduled event exception represents a skipped or rescheduled recurrence for the scheduled event's [recurrence rule](/docs/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object). In the client, scheduled event exceptions are commonly known as "canceled events" or "re-scheduled events". + +###### Guild Scheduled Event Exception Structure + +| Field | Type | Description +|-----------------------|--------------------------------------------------------|---------------------------------------------------------------------------------| +| event_id | snowflake | the id of the scheduled event the exception belongs to | +| event_exception_id * | snowflake | a snowflake containing the original scheduled start time of the scheduled event | +| scheduled_start_time | ?[ISO8601 timestamp](/docs/reference#iso8601-datetime) | the new time at when the scheduled event recurrence will start, if applicable | +| scheduled_start_time | ?[ISO8601 timestamp](/docs/reference#iso8601-datetime) | the new time at when the scheduled event recurrence will end, if applicable | +| is_canceled | boolean | whether or not the scheduled event will be skipped on the recurrence | + +\* The snowflake in this field is not guranteed to be globally unique. + ## List Scheduled Events for Guild /guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events @@ -364,6 +380,10 @@ All parameters to this endpoint are optional Delete a guild scheduled event. Returns a `204` on success. Fires a [Guild Scheduled Event Delete](/docs/events/gateway-events#guild-scheduled-event-delete) Gateway event. +:::info +This endpoint supports the `X-Audit-Log-Reason` header. +::: + ## Get Guild Scheduled Event Users /guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object)/users @@ -380,6 +400,103 @@ Get a list of guild scheduled event users subscribed to a guild scheduled event. \* 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. +## Create Guild Scheduled Event Exception +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object)/exceptions + +Create an exception for the guild scheduled event's recurrence rule. Returns the created [guild scheduled event exception object](/docs/resources/guild-scheduled-event#guild-scheduled-event-exception-object) on success. Fires a [Guild Scheduled Event Exception Create](/docs/events/gateway-events#guild-scheduled-event-exception-create) Gateway event. + +:::info +This endpoint supports the `X-Audit-Log-Reason` header. +::: + +:::warn +At minimum, you must provide a value for one of `is_canceled`, `scheduled_start_time`, or `scheduled_end_time`. Otherwise, the request will fail with an [180005 JSON error code](/docs/topics/opcodes-and-status-codes.md#json-error-codes). +::: + +###### JSON Params + +| Field | Type | Description | +|-------------------------------|--------------------------------------------------------|-------------------------------------------------------------------| +| original_scheduled_start_time | [ISO8601 timestamp](/docs/reference#iso8601-datetime) | the original time at when the scheduled event would've started | +| scheduled_start_time? | ?[ISO8601 timestamp](/docs/reference#iso8601-datetime) | the new scheduled start time for the scheduled event's recurrence | +| scheduled_end_time? | ?[ISO8601 timestamp](/docs/reference#iso8601-datetime) | the new scheduled end time for the scheduled event's recurrence | +| is_canceled? | boolean | whether the scheduled event should be skipped on this recurrence | + +## Modify Guild Scheduled Event Exception +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object)/exceptions/[\{guild_scheduled_event_exception.event_exception_id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-exception-object) + +Modify an exception for the guild scheduled event's recurrence rule. Returns the updated [guild scheduled event exception object](/docs/resources/guild-scheduled-event#guild-scheduled-event-exception-object) on success. Fires a [Guild Scheduled Event Exception Update](/docs/events/gateway-events#guild-scheduled-event-exception-update) Gateway event. + +:::info +This endpoint supports the `X-Audit-Log-Reason` header. +::: + +:::info +All parameters to this endpoint are optional. +::: + +###### JSON Params + +| Field | Type | Description | +|----------------------|--------------------------------------------------------|-------------------------------------------------------------------| +| scheduled_start_time | ?[ISO8601 timestamp](/docs/reference#iso8601-datetime) | the new scheduled start time for the scheduled event's recurrence | +| scheduled_end_time | ?[ISO8601 timestamp](/docs/reference#iso8601-datetime) | the new scheduled end time for the scheduled event's recurrence | +| is_canceled | boolean | whether the scheduled event should be skipped on this recurrence | + +## Delete Guild Scheduled Event Exception +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object)/exceptions/[\{guild_scheduled_event_exception.event_exception_id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-exception-object) + +Delete an exception for the guild scheduled event's recurrence rule. Returns a `204` on success. Fires a [Guild Scheduled Event Exception Delete](/docs/events/gateway-events#guild-scheduled-event-exception-delete) Gateway event. + +:::info +This endpoint supports the `X-Audit-Log-Reason` header. +::: + +## Get Guild Scheduled Event Exception Users +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object)/exceptions/[\{guild_scheduled_event_exception.event_exception_id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-exception-object)/users + +Get a list of guild scheduled event users subscribed to a specific guild scheduled event exception. Returns a list of [guild scheduled event user](/docs/resources/guild-scheduled-event#guild-scheduled-event-user-object) objects on success. Guild member data, if it exists, is included if the `with_member` query parameter is set. + +###### Query String Params + +| Field | Type | Description | Default | +|--------------|--------------------------------------------------|-----------------------------------------------|---------| +| limit? | number | number of users to return (up to maximum 100) | 100 | +| with_member? | [boolean](/docs/reference#boolean-query-strings) | include guild member data if it exists | false | +| before? * | snowflake | consider only users before given user id | null | +| after? * | snowflake | consider only users after given user id | null | + +\* 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. + +## Get Guild Scheduled Event User count +/guilds/[\{guild.id\}](/docs/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/docs/resources/guild-scheduled-event#guild-scheduled-event-object)/users/counts + +Get the amount of users that are currently subscribed to a guild scheduled event, and optionally the scheduled event's exceptions. + +###### Query String Params + +| Field | Type | Description | +|--------------------------------------|---------------------|-------------------------------------------------------------------------------------------| +| guild_scheduled_event_exception_ids? | array of snowflakes | the ids of the guild scheduled event exceptions to return user counts for (maximum of 10) | + +###### Response Body + +| Field | Type | Description | +|----------------------------------------|---------|-------------------------------------------------------------------------------------------------------------------| +| guild_scheduled_event_count | integer | the amount of users that are subscribed to the guild scheduled event | +| guild_scheduled_event_exception_counts | object | an object mapping guild scheduled event exception ids to the number of users that are subscribed to the exception | + +###### Example Response Body + +```json +{ + "guild_scheduled_event_count": 122, + "guild_scheduled_event_exception_counts": { + "1446863752396800000": 6, + "1449400467456000000": 7 + } +} +``` ## Guild Scheduled Event Status Update Automation From 47961ecb6e4e74f83c3be0472715a7e230ba986c Mon Sep 17 00:00:00 2001 From: Droid <174426320+Droid00000@users.noreply.github.com> Date: Fri, 9 Jan 2026 17:41:22 -0500 Subject: [PATCH 2/4] Droid - Fix wrong field names --- docs/events/gateway-events.mdx | 169 +++++++++++------------ docs/resources/guild-scheduled-event.mdx | 14 +- 2 files changed, 91 insertions(+), 92 deletions(-) diff --git a/docs/events/gateway-events.mdx b/docs/events/gateway-events.mdx index f2b42abb6d..f132c8cc66 100644 --- a/docs/events/gateway-events.mdx +++ b/docs/events/gateway-events.mdx @@ -304,91 +304,90 @@ Sent by the client to indicate a presence or status update. Receive events are Gateway events encapsulated in an [event payload](/docs/events/gateway-events#payload-structure), and are sent by Discord to an app through a Gateway connection. Receive events correspond to events that happen in a Discord server where the app is installed. -| Name | Description | -|----------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------| -| [Hello](/docs/events/gateway-events#hello) | Defines the heartbeat interval | -| [Ready](/docs/events/gateway-events#ready) | Contains the initial state information | -| [Resumed](/docs/events/gateway-events#resumed) | Response to [Resume](/docs/events/gateway-events#resume) | -| [Reconnect](/docs/events/gateway-events#reconnect) | Server is going away, client should reconnect to gateway and resume | -| [Rate Limited](/docs/events/gateway-events#rate-limited) | Application was rate limited for a gateway opcode | -| [Invalid Session](/docs/events/gateway-events#invalid-session) | Failure response to [Identify](/docs/events/gateway-events#identify) or [Resume](/docs/events/gateway-events#resume) or invalid active session | -| [Application Command Permissions Update](/docs/events/gateway-events#application-command-permissions-update) | Application command permission was updated | -| [Auto Moderation Rule Create](/docs/events/gateway-events#auto-moderation-rule-create) | Auto Moderation rule was created | -| [Auto Moderation Rule Update](/docs/events/gateway-events#auto-moderation-rule-update) | Auto Moderation rule was updated | -| [Auto Moderation Rule Delete](/docs/events/gateway-events#auto-moderation-rule-delete) | Auto Moderation rule was deleted | -| [Auto Moderation Action Execution](/docs/events/gateway-events#auto-moderation-action-execution) | Auto Moderation rule was triggered and an action was executed (e.g. a message was blocked) | -| [Channel Create](/docs/events/gateway-events#channel-create) | New guild channel created | -| [Channel Update](/docs/events/gateway-events#channel-update) | Channel was updated | -| [Channel Delete](/docs/events/gateway-events#channel-delete) | Channel was deleted | -| [Channel Pins Update](/docs/events/gateway-events#channel-pins-update) | Message was pinned or unpinned | -| [Thread Create](/docs/events/gateway-events#thread-create) | Thread created, also sent when being added to a private thread | -| [Thread Update](/docs/events/gateway-events#thread-update) | Thread was updated | -| [Thread Delete](/docs/events/gateway-events#thread-delete) | Thread was deleted | -| [Thread List Sync](/docs/events/gateway-events#thread-list-sync) | Sent when gaining access to a channel, contains all active threads in that channel | -| [Thread Member Update](/docs/events/gateway-events#thread-member-update) | [Thread member](/docs/resources/channel#thread-member-object) for the current user was updated | -| [Thread Members Update](/docs/events/gateway-events#thread-members-update) | Some user(s) were added to or removed from a thread | -| [Entitlement Create](/docs/events/gateway-events#entitlement-create) | Entitlement was created | -| [Entitlement Update](/docs/events/gateway-events#entitlement-update) | Entitlement was updated or renewed | -| [Entitlement Delete](/docs/events/gateway-events#entitlement-delete) | Entitlement was deleted | -| [Guild Create](/docs/events/gateway-events#guild-create) | Lazy-load for unavailable guild, guild became available, or user joined a new guild | -| [Guild Update](/docs/events/gateway-events#guild-update) | Guild was updated | -| [Guild Delete](/docs/events/gateway-events#guild-delete) | Guild became unavailable, or user left/was removed from a guild | -| [Guild Audit Log Entry Create](/docs/events/gateway-events#guild-audit-log-entry-create) | A guild audit log entry was created | -| [Guild Ban Add](/docs/events/gateway-events#guild-ban-add) | User was banned from a guild | -| [Guild Ban Remove](/docs/events/gateway-events#guild-ban-remove) | User was unbanned from a guild | -| [Guild Emojis Update](/docs/events/gateway-events#guild-emojis-update) | Guild emojis were updated | -| [Guild Stickers Update](/docs/events/gateway-events#guild-stickers-update) | Guild stickers were updated | -| [Guild Integrations Update](/docs/events/gateway-events#guild-integrations-update) | Guild integration was updated | -| [Guild Member Add](/docs/events/gateway-events#guild-member-add) | New user joined a guild | -| [Guild Member Remove](/docs/events/gateway-events#guild-member-remove) | User was removed from a guild | -| [Guild Member Update](/docs/events/gateway-events#guild-member-update) | Guild member was updated | -| [Guild Members Chunk](/docs/events/gateway-events#guild-members-chunk) | Response to [Request Guild Members](/docs/events/gateway-events#request-guild-members) | -| [Guild Role Create](/docs/events/gateway-events#guild-role-create) | Guild role was created | -| [Guild Role Update](/docs/events/gateway-events#guild-role-update) | Guild role was updated | -| [Guild Role Delete](/docs/events/gateway-events#guild-role-delete) | Guild role was deleted | -| [Guild Scheduled Event Create](/docs/events/gateway-events#guild-scheduled-event-create) | Guild scheduled event was created | -| [Guild Scheduled Event Update](/docs/events/gateway-events#guild-scheduled-event-update) | Guild scheduled event was updated | -| [Guild Scheduled Event Delete](/docs/events/gateway-events#guild-scheduled-event-delete) | Guild scheduled event was deleted | -| [Guild Scheduled Event User Add](/docs/events/gateway-events#guild-scheduled-event-user-add) | User subscribed to a guild scheduled event | -| [Guild Scheduled Event User Remove](/docs/events/gateway-events#guild-scheduled-event-user-remove) | User unsubscribed from a guild scheduled event | -| [Guild Soundboard Sound Create](/docs/events/gateway-events#guild-soundboard-sound-create) | Guild soundboard sound was created | -| [Guild Soundboard Sound Update](/docs/events/gateway-events#guild-soundboard-sound-update) | Guild soundboard sound was updated | -| [Guild Soundboard Sound Delete](/docs/events/gateway-events#guild-soundboard-sound-delete) | Guild soundboard sound was deleted | -| [Guild Soundboard Sounds Update](/docs/events/gateway-events#guild-soundboard-sounds-update) | Guild soundboard sounds were updated | -| [Soundboard Sounds](/docs/events/gateway-events#soundboard-sounds) | Response to [Request Soundboard Sounds](/docs/events/gateway-events#request-soundboard-sounds) | -| [Integration Create](/docs/events/gateway-events#integration-create) | Guild integration was created | -| [Integration Update](/docs/events/gateway-events#integration-update) | Guild integration was updated | -| [Integration Delete](/docs/events/gateway-events#integration-delete) | Guild integration was deleted | -| [Interaction Create](/docs/events/gateway-events#interaction-create) | User used an interaction, such as an [Application Command](/docs/interactions/application-commands) | -| [Invite Create](/docs/events/gateway-events#invite-create) | Invite to a channel was created | -| [Invite Delete](/docs/events/gateway-events#invite-delete) | Invite to a channel was deleted | -| [Message Create](/docs/events/gateway-events#message-create) | Message was created | -| [Message Update](/docs/events/gateway-events#message-update) | Message was edited | -| [Message Delete](/docs/events/gateway-events#message-delete) | Message was deleted | -| [Message Delete Bulk](/docs/events/gateway-events#message-delete-bulk) | Multiple messages were deleted at once | -| [Message Reaction Add](/docs/events/gateway-events#message-reaction-add) | User reacted to a message | -| [Message Reaction Remove](/docs/events/gateway-events#message-reaction-remove) | User removed a reaction from a message | -| [Message Reaction Remove All](/docs/events/gateway-events#message-reaction-remove-all) | All reactions were explicitly removed from a message | -| [Message Reaction Remove Emoji](/docs/events/gateway-events#message-reaction-remove-emoji) | All reactions for a given emoji were explicitly removed from a message | -| [Presence Update](/docs/events/gateway-events#presence-update) | User was updated | -| [Stage Instance Create](/docs/events/gateway-events#stage-instance-create) | Stage instance was created | -| [Stage Instance Update](/docs/events/gateway-events#stage-instance-update) | Stage instance was updated | -| [Stage Instance Delete](/docs/events/gateway-events#stage-instance-delete) | Stage instance was deleted or closed | -| [Subscription Create](/docs/events/gateway-events#subscription-create) | Premium App Subscription was created | -| [Subscription Update](/docs/events/gateway-events#subscription-update) | Premium App Subscription was updated | -| [Subscription Delete](/docs/events/gateway-events#subscription-delete) | Premium App Subscription was deleted | -| [Typing Start](/docs/events/gateway-events#typing-start) | User started typing in a channel | -| [User Update](/docs/events/gateway-events#user-update) | Properties about the user changed | -| [Voice Channel Effect Send](/docs/events/gateway-events#voice-channel-effect-send) | Someone sent an effect in a voice channel the current user is connected to | -| [Voice State Update](/docs/events/gateway-events#voice-state-update) | Someone joined, left, or moved a voice channel | -| [Voice Server Update](/docs/events/gateway-events#voice-server-update) | Guild's voice server was updated | -| [Webhooks Update](/docs/events/gateway-events#webhooks-update) | Guild channel webhook was created, update, or deleted | -| [Message Poll Vote Add](/docs/events/gateway-events#message-poll-vote-add) | User voted on a poll | -| [Message Poll Vote Remove](/docs/events/gateway-events#message-poll-vote-remove) | User removed a vote on a poll | -| [Guild Scheduled Event Exception Create](/docs/events/gateway-events#guild-scheduled-event-exception-create) | Guild scheduled event exception was created | -| [Guild Scheduled Event Exception Update](/docs/events/gateway-events#guild-scheduled-event-exception-update) | Guild scheduled event exception was updated | -| [Guild Scheduled Event Exception Delete](/docs/events/gateway-events#guild-scheduled-event-exception-delete) | Guild scheduled event exception was deleted | -| [Guild Scheduled Event Exceptions Delete](/docs/events/gateway-events#guild-scheduled-event-exceptions-delete) | All of the exceptions for a guild scheduled event were deleted | +| Name | Description | +|--------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------| +| [Hello](/docs/events/gateway-events#hello) | Defines the heartbeat interval | +| [Ready](/docs/events/gateway-events#ready) | Contains the initial state information | +| [Resumed](/docs/events/gateway-events#resumed) | Response to [Resume](/docs/events/gateway-events#resume) | +| [Reconnect](/docs/events/gateway-events#reconnect) | Server is going away, client should reconnect to gateway and resume | +| [Rate Limited](/docs/events/gateway-events#rate-limited) | Application was rate limited for a gateway opcode | +| [Invalid Session](/docs/events/gateway-events#invalid-session) | Failure response to [Identify](/docs/events/gateway-events#identify) or [Resume](/docs/events/gateway-events#resume) or invalid active session | +| [Application Command Permissions Update](/docs/events/gateway-events#application-command-permissions-update) | Application command permission was updated | +| [Auto Moderation Rule Create](/docs/events/gateway-events#auto-moderation-rule-create) | Auto Moderation rule was created | +| [Auto Moderation Rule Update](/docs/events/gateway-events#auto-moderation-rule-update) | Auto Moderation rule was updated | +| [Auto Moderation Rule Delete](/docs/events/gateway-events#auto-moderation-rule-delete) | Auto Moderation rule was deleted | +| [Auto Moderation Action Execution](/docs/events/gateway-events#auto-moderation-action-execution) | Auto Moderation rule was triggered and an action was executed (e.g. a message was blocked) | +| [Channel Create](/docs/events/gateway-events#channel-create) | New guild channel created | +| [Channel Update](/docs/events/gateway-events#channel-update) | Channel was updated | +| [Channel Delete](/docs/events/gateway-events#channel-delete) | Channel was deleted | +| [Channel Pins Update](/docs/events/gateway-events#channel-pins-update) | Message was pinned or unpinned | +| [Thread Create](/docs/events/gateway-events#thread-create) | Thread created, also sent when being added to a private thread | +| [Thread Update](/docs/events/gateway-events#thread-update) | Thread was updated | +| [Thread Delete](/docs/events/gateway-events#thread-delete) | Thread was deleted | +| [Thread List Sync](/docs/events/gateway-events#thread-list-sync) | Sent when gaining access to a channel, contains all active threads in that channel | +| [Thread Member Update](/docs/events/gateway-events#thread-member-update) | [Thread member](/docs/resources/channel#thread-member-object) for the current user was updated | +| [Thread Members Update](/docs/events/gateway-events#thread-members-update) | Some user(s) were added to or removed from a thread | +| [Entitlement Create](/docs/events/gateway-events#entitlement-create) | Entitlement was created | +| [Entitlement Update](/docs/events/gateway-events#entitlement-update) | Entitlement was updated or renewed | +| [Entitlement Delete](/docs/events/gateway-events#entitlement-delete) | Entitlement was deleted | +| [Guild Create](/docs/events/gateway-events#guild-create) | Lazy-load for unavailable guild, guild became available, or user joined a new guild | +| [Guild Update](/docs/events/gateway-events#guild-update) | Guild was updated | +| [Guild Delete](/docs/events/gateway-events#guild-delete) | Guild became unavailable, or user left/was removed from a guild | +| [Guild Audit Log Entry Create](/docs/events/gateway-events#guild-audit-log-entry-create) | A guild audit log entry was created | +| [Guild Ban Add](/docs/events/gateway-events#guild-ban-add) | User was banned from a guild | +| [Guild Ban Remove](/docs/events/gateway-events#guild-ban-remove) | User was unbanned from a guild | +| [Guild Emojis Update](/docs/events/gateway-events#guild-emojis-update) | Guild emojis were updated | +| [Guild Stickers Update](/docs/events/gateway-events#guild-stickers-update) | Guild stickers were updated | +| [Guild Integrations Update](/docs/events/gateway-events#guild-integrations-update) | Guild integration was updated | +| [Guild Member Add](/docs/events/gateway-events#guild-member-add) | New user joined a guild | +| [Guild Member Remove](/docs/events/gateway-events#guild-member-remove) | User was removed from a guild | +| [Guild Member Update](/docs/events/gateway-events#guild-member-update) | Guild member was updated | +| [Guild Members Chunk](/docs/events/gateway-events#guild-members-chunk) | Response to [Request Guild Members](/docs/events/gateway-events#request-guild-members) | +| [Guild Role Create](/docs/events/gateway-events#guild-role-create) | Guild role was created | +| [Guild Role Update](/docs/events/gateway-events#guild-role-update) | Guild role was updated | +| [Guild Role Delete](/docs/events/gateway-events#guild-role-delete) | Guild role was deleted | +| [Guild Scheduled Event Create](/docs/events/gateway-events#guild-scheduled-event-create) | Guild scheduled event was created | +| [Guild Scheduled Event Update](/docs/events/gateway-events#guild-scheduled-event-update) | Guild scheduled event was updated | +| [Guild Scheduled Event Delete](/docs/events/gateway-events#guild-scheduled-event-delete) | Guild scheduled event was deleted | +| [Guild Scheduled Event User Add](/docs/events/gateway-events#guild-scheduled-event-user-add) | User subscribed to a guild scheduled event | +| [Guild Scheduled Event User Remove](/docs/events/gateway-events#guild-scheduled-event-user-remove) | User unsubscribed from a guild scheduled event | +| [Guild Soundboard Sound Create](/docs/events/gateway-events#guild-soundboard-sound-create) | Guild soundboard sound was created | +| [Guild Soundboard Sound Update](/docs/events/gateway-events#guild-soundboard-sound-update) | Guild soundboard sound was updated | +| [Guild Soundboard Sound Delete](/docs/events/gateway-events#guild-soundboard-sound-delete) | Guild soundboard sound was deleted | +| [Guild Soundboard Sounds Update](/docs/events/gateway-events#guild-soundboard-sounds-update) | Guild soundboard sounds were updated | +| [Soundboard Sounds](/docs/events/gateway-events#soundboard-sounds) | Response to [Request Soundboard Sounds](/docs/events/gateway-events#request-soundboard-sounds) | +| [Integration Create](/docs/events/gateway-events#integration-create) | Guild integration was created | +| [Integration Update](/docs/events/gateway-events#integration-update) | Guild integration was updated | +| [Integration Delete](/docs/events/gateway-events#integration-delete) | Guild integration was deleted | +| [Interaction Create](/docs/events/gateway-events#interaction-create) | User used an interaction, such as an [Application Command](/docs/interactions/application-commands) | +| [Invite Create](/docs/events/gateway-events#invite-create) | Invite to a channel was created | +| [Invite Delete](/docs/events/gateway-events#invite-delete) | Invite to a channel was deleted | +| [Message Create](/docs/events/gateway-events#message-create) | Message was created | +| [Message Update](/docs/events/gateway-events#message-update) | Message was edited | +| [Message Delete](/docs/events/gateway-events#message-delete) | Message was deleted | +| [Message Delete Bulk](/docs/events/gateway-events#message-delete-bulk) | Multiple messages were deleted at once | +| [Message Reaction Add](/docs/events/gateway-events#message-reaction-add) | User reacted to a message | +| [Message Reaction Remove](/docs/events/gateway-events#message-reaction-remove) | User removed a reaction from a message | +| [Message Reaction Remove All](/docs/events/gateway-events#message-reaction-remove-all) | All reactions were explicitly removed from a message | +| [Message Reaction Remove Emoji](/docs/events/gateway-events#message-reaction-remove-emoji) | All reactions for a given emoji were explicitly removed from a message | +| [Presence Update](/docs/events/gateway-events#presence-update) | User was updated | +| [Stage Instance Create](/docs/events/gateway-events#stage-instance-create) | Stage instance was created | +| [Stage Instance Update](/docs/events/gateway-events#stage-instance-update) | Stage instance was updated | +| [Stage Instance Delete](/docs/events/gateway-events#stage-instance-delete) | Stage instance was deleted or closed | +| [Subscription Create](/docs/events/gateway-events#subscription-create) | Premium App Subscription was created | +| [Subscription Update](/docs/events/gateway-events#subscription-update) | Premium App Subscription was updated | +| [Subscription Delete](/docs/events/gateway-events#subscription-delete) | Premium App Subscription was deleted | +| [Typing Start](/docs/events/gateway-events#typing-start) | User started typing in a channel | +| [User Update](/docs/events/gateway-events#user-update) | Properties about the user changed | +| [Voice Channel Effect Send](/docs/events/gateway-events#voice-channel-effect-send) | Someone sent an effect in a voice channel the current user is connected to | +| [Voice State Update](/docs/events/gateway-events#voice-state-update) | Someone joined, left, or moved a voice channel | +| [Voice Server Update](/docs/events/gateway-events#voice-server-update) | Guild's voice server was updated | +| [Webhooks Update](/docs/events/gateway-events#webhooks-update) | Guild channel webhook was created, update, or deleted | +| [Message Poll Vote Add](/docs/events/gateway-events#message-poll-vote-add) | User voted on a poll | +| [Message Poll Vote Remove](/docs/events/gateway-events#message-poll-vote-remove) | User removed a vote on a poll | +| [Guild Scheduled Event Exception Create](/docs/events/gateway-events#guild-scheduled-event-exception-create) | Guild scheduled event exception was created | +| [Guild Scheduled Event Exception Update](/docs/events/gateway-events#guild-scheduled-event-exception-update) | Guild scheduled event exception was updated | +| [Guild Scheduled Event Exception Delete](/docs/events/gateway-events#guild-scheduled-event-exception-delete) | Guild scheduled event exception was deleted | #### Hello diff --git a/docs/resources/guild-scheduled-event.mdx b/docs/resources/guild-scheduled-event.mdx index fd299cd7df..b240e6bace 100644 --- a/docs/resources/guild-scheduled-event.mdx +++ b/docs/resources/guild-scheduled-event.mdx @@ -266,13 +266,13 @@ A guild scheduled event exception represents a skipped or rescheduled recurrence ###### Guild Scheduled Event Exception Structure -| Field | Type | Description -|-----------------------|--------------------------------------------------------|---------------------------------------------------------------------------------| -| event_id | snowflake | the id of the scheduled event the exception belongs to | -| event_exception_id * | snowflake | a snowflake containing the original scheduled start time of the scheduled event | -| scheduled_start_time | ?[ISO8601 timestamp](/docs/reference#iso8601-datetime) | the new time at when the scheduled event recurrence will start, if applicable | -| scheduled_start_time | ?[ISO8601 timestamp](/docs/reference#iso8601-datetime) | the new time at when the scheduled event recurrence will end, if applicable | -| is_canceled | boolean | whether or not the scheduled event will be skipped on the recurrence | +| Field | Type | Description +|----------------------|--------------------------------------------------------|---------------------------------------------------------------------------------| +| event_id | snowflake | the id of the scheduled event the exception belongs to | +| event_exception_id * | snowflake | a snowflake containing the original scheduled start time of the scheduled event | +| scheduled_start_time | ?[ISO8601 timestamp](/docs/reference#iso8601-datetime) | the new time at when the scheduled event recurrence will start, if applicable | +| scheduled_end_time | ?[ISO8601 timestamp](/docs/reference#iso8601-datetime) | the new time at when the scheduled event recurrence will end, if applicable | +| is_canceled | boolean | whether or not the scheduled event will be skipped on the recurrence | \* The snowflake in this field is not guranteed to be globally unique. From 32a5c747bb155d0753e557571a55bf0d24c8d8d3 Mon Sep 17 00:00:00 2001 From: Droid <174426320+Droid00000@users.noreply.github.com> Date: Wed, 11 Feb 2026 18:42:37 -0500 Subject: [PATCH 3/4] Droid - Properly reference ISO8601 format --- developers/events/gateway-events.mdx | 6 +- .../resources/guild-scheduled-event.mdx | 67 ++++++++++--------- 2 files changed, 37 insertions(+), 36 deletions(-) diff --git a/developers/events/gateway-events.mdx b/developers/events/gateway-events.mdx index 4abe8df218..0756f02a45 100644 --- a/developers/events/gateway-events.mdx +++ b/developers/events/gateway-events.mdx @@ -927,15 +927,15 @@ Sent when a user has unsubscribed from a guild scheduled event. #### Guild Scheduled Event Exception Create -Sent when a guild scheduled event exception is created. The inner payload is a [guild scheduled event exception](/developers/resources/guild-scheduled-event#guild-scheduled-event-exception-object) object with an extra `guild_id` key. +Sent when a guild scheduled event exception is created. The inner payload is a [guild scheduled event exception](/developers/resources/guild-scheduled-event#guild-scheduled-event-exception-object) object with an additional `guild_id` key. #### Guild Scheduled Event Exception Update -Sent when a guild scheduled event exception is updated. The inner payload is a [guild scheduled event exception](/developers/resources/guild-scheduled-event#guild-scheduled-event-exception-object) object with an extra `guild_id` key. +Sent when a guild scheduled event exception is updated. The inner payload is a [guild scheduled event exception](/developers/resources/guild-scheduled-event#guild-scheduled-event-exception-object) object with an additional `guild_id` key. #### Guild Scheduled Event Exception Delete -Sent when a guild scheduled event exception is deleted. The inner payload is a [guild scheduled event exception](/developers/resources/guild-scheduled-event#guild-scheduled-event-exception-object) object with an extra `guild_id` key. +Sent when a guild scheduled event exception is deleted. The inner payload is a [guild scheduled event exception](/developers/resources/guild-scheduled-event#guild-scheduled-event-exception-object) object with an additional `guild_id` key. #### Guild Soundboard Sound Create diff --git a/developers/resources/guild-scheduled-event.mdx b/developers/resources/guild-scheduled-event.mdx index b62ecb3e8a..ed81075b40 100644 --- a/developers/resources/guild-scheduled-event.mdx +++ b/developers/resources/guild-scheduled-event.mdx @@ -263,10 +263,10 @@ by_month_day = [24] ###### Guild Scheduled Event Recurrence Rule - N_Weekday Structure -| Field | Type | Description | -|-------|------|-------------------------------| -| n | int | The week to reoccur on. 1 - 5 | -| day | [recurrence rule - weekday](/developers/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-weekday) | The day within the week to reoccur on | | guild member data for this user for the guild which this event belongs to, if any | +| Field | Type | Description | +|-------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------| +| n | integer | The week to reoccur on. 1 - 5 | +| day | [recurrence rule - weekday](/developers/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object-guild-scheduled-event-recurrence-rule-weekday) | The day within the week to reoccur on | ###### Guild Scheduled Event Recurrence Rule - Month @@ -287,17 +287,18 @@ by_month_day = [24] | DECEMBER | 12 | ### Guild Scheduled Event Exception Object -A guild scheduled event exception represents a skipped or rescheduled recurrence for the scheduled event's [recurrence rule](/developers/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object). In the client, scheduled event exceptions are commonly known as "canceled events" or "re-scheduled events". +A guild scheduled event exception represents a skipped or rescheduled recurrence for the scheduled event's [recurrence rule](/developers/resources/guild-scheduled-event#guild-scheduled-event-recurrence-rule-object). In the client, scheduled event exceptions are commonly highlighted as events that have had specific recurrences canceled. + ###### Guild Scheduled Event Exception Structure -| Field | Type | Description | -|----------------------|--------------------------------------------------------------|--------------------------------------------------------------------------------------------| -| event_id | snowflake | the id of the scheduled event the exception belongs to | -| event_exception_id * | snowflake | a snowflake containing the original scheduled start time of the scheduled event recurrence | -| scheduled_start_time | ?[ISO8601 timestamp](/developers/reference#iso8601-datetime) | the new time at when the scheduled event recurrence will start, if applicable | -| scheduled_end_time | ?[ISO8601 timestamp](/developers/reference#iso8601-datetime) | the new time at when the scheduled event recurrence will end, if applicable | -| is_canceled | boolean | whether or not the scheduled event will be skipped on the recurrence | +| Field | Type | Description | +|----------------------|-----------------------------------------------------------------|--------------------------------------------------------------------------------------------| +| event_id | snowflake | the id of the scheduled event the exception belongs to | +| event_exception_id * | snowflake | a snowflake containing the original scheduled start time of the scheduled event recurrence | +| scheduled_start_time | ?[ISO8601 timestamp](/developers/reference#iso8601-date%2Ftime) | the new time at when the scheduled event recurrence will start, if applicable | +| scheduled_end_time | ?[ISO8601 timestamp](/developers/reference#iso8601-date%2Ftime) | the new time at when the scheduled event recurrence will end, if applicable | +| is_canceled | boolean | whether or not the scheduled event will be skipped on the recurrence | \* The snowflake in this field is not guranteed to be globally unique. @@ -413,7 +414,6 @@ Delete a guild scheduled event. Returns a `204` on success. Fires a [Guild Sched This endpoint supports the `X-Audit-Log-Reason` header. - ## Get Guild Scheduled Event Users /guilds/[\{guild.id\}](/developers/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/developers/resources/guild-scheduled-event#guild-scheduled-event-object)/users @@ -441,20 +441,19 @@ This endpoint supports the `X-Audit-Log-Reason` header. -At minimum, you must provide a value for one of `is_canceled`, `scheduled_start_time`, or `scheduled_end_time`. Otherwise, the request will fail with an [180005 JSON error code](/developers/topics/opcodes-and-status-codes.md#json-error-codes). +At minimum, you must provide a value for one of `is_canceled`, `scheduled_start_time`, or `scheduled_end_time`. Otherwise, the request will fail with an [180005 JSON error code](/developers/topics/opcodes-and-status-codes#json). ###### JSON Params -| Field | Type | Description | -|-------------------------------|--------------------------------------------------------------|---------------------------------------------------------------------------| -| original_scheduled_start_time | [ISO8601 timestamp](/developers/reference#iso8601-datetime) | the original time at when the scheduled event recurrence would've started | -| scheduled_start_time? | ?[ISO8601 timestamp](/developers/reference#iso8601-datetime) | the new scheduled start time for the scheduled event's recurrence | -| scheduled_end_time? | ?[ISO8601 timestamp](/developers/reference#iso8601-datetime) | the new scheduled end time for the scheduled event's recurrence | -| is_canceled? | boolean | whether the scheduled event should be skipped on this recurrence | +| Field | Type | Description | +|-------------------------------|-----------------------------------------------------------------|---------------------------------------------------------------------------| +| scheduled_start_time? | ?[ISO8601 timestamp](/developers/reference#iso8601-date%2Ftime) | the new scheduled start time for the scheduled event's recurrence | +| scheduled_end_time? | ?[ISO8601 timestamp](/developers/reference#iso8601-date%2Ftime) | the new scheduled end time for the scheduled event's recurrence | +| is_canceled? | boolean | whether the scheduled event should be skipped on this recurrence | ## Modify Guild Scheduled Event Exception -/guilds/[\{guild.id\}](/developers/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/developers/resources/guild-scheduled-event#guild-scheduled-event-object)/exceptions/[\{guild_scheduled_event_exception.event_exception_id\}](/developers/resources/guild-scheduled-event#guild-scheduled-event-exception-object) +/guilds/[\{guild.id\}](/developers/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/developers/resources/guild-scheduled-event#guild-scheduled-event-object)/exceptions/[\{exception.id\}](/developers/resources/guild-scheduled-event#guild-scheduled-event-exception-object) Modify an exception for the guild scheduled event's recurrence rule. Returns the updated [guild scheduled event exception object](/developers/resources/guild-scheduled-event#guild-scheduled-event-exception-object) on success. Fires a [Guild Scheduled Event Exception Update](/developers/events/gateway-events#guild-scheduled-event-exception-update) Gateway event. @@ -468,14 +467,14 @@ All parameters to this endpoint are optional. ###### JSON Params -| Field | Type | Description | -|----------------------|--------------------------------------------------------------|-------------------------------------------------------------------| -| scheduled_start_time | ?[ISO8601 timestamp](/developers/reference#iso8601-datetime) | the new scheduled start time for the scheduled event's recurrence | -| scheduled_end_time | ?[ISO8601 timestamp](/developers/reference#iso8601-datetime) | the new scheduled end time for the scheduled event's recurrence | -| is_canceled | boolean | whether the scheduled event should be skipped on this recurrence | +| Field | Type | Description | +|----------------------|-----------------------------------------------------------------|-------------------------------------------------------------------| +| scheduled_start_time | ?[ISO8601 timestamp](/developers/reference#iso8601-date%2Ftime) | the new scheduled start time for the scheduled event's recurrence | +| scheduled_end_time | ?[ISO8601 timestamp](/developers/reference#iso8601-date%2Ftime) | the new scheduled end time for the scheduled event's recurrence | +| is_canceled | boolean | whether the scheduled event should be skipped on this recurrence | ## Delete Guild Scheduled Event Exception -/guilds/[\{guild.id\}](/developers/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/developers/resources/guild-scheduled-event#guild-scheduled-event-object)/exceptions/[\{guild_scheduled_event_exception.event_exception_id\}](/developers/resources/guild-scheduled-event#guild-scheduled-event-exception-object) +/guilds/[\{guild.id\}](/developers/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/developers/resources/guild-scheduled-event#guild-scheduled-event-object)/exceptions/[\{exception.id\}](/developers/resources/guild-scheduled-event#guild-scheduled-event-exception-object) Delete an exception for the guild scheduled event's recurrence rule. Returns a `204` on success. Fires a [Guild Scheduled Event Exception Delete](/developers/events/gateway-events#guild-scheduled-event-exception-delete) Gateway event. @@ -484,10 +483,11 @@ This endpoint supports the `X-Audit-Log-Reason` header. ## Get Guild Scheduled Event Exception Users -/guilds/[\{guild.id\}](/developers/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/developers/resources/guild-scheduled-event#guild-scheduled-event-object)/exceptions/[\{guild_scheduled_event_exception.event_exception_id\}](/developers/resources/guild-scheduled-event#guild-scheduled-event-exception-object)/users +/guilds/[\{guild.id\}](/developers/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/developers/resources/guild-scheduled-event#guild-scheduled-event-object)/exceptions/[\{exception.id\}](/developers/resources/guild-scheduled-event#guild-scheduled-event-exception-object)/users Get a list of guild scheduled event users subscribed to a specific guild scheduled event exception. Returns a list of [guild scheduled event user](/developers/resources/guild-scheduled-event#guild-scheduled-event-user-object) objects on success. Guild member data, if it exists, is included if the `with_member` query parameter is set. + ###### Query String Params | Field | Type | Description | Default | @@ -504,6 +504,7 @@ Get a list of guild scheduled event users subscribed to a specific guild schedul Get the amount of users that are currently subscribed to a guild scheduled event, and optionally the scheduled event's exceptions. + ###### Query String Params | Field | Type | Description | @@ -521,11 +522,11 @@ Get the amount of users that are currently subscribed to a guild scheduled event ```json { - "guild_scheduled_event_count": 122, - "guild_scheduled_event_exception_counts": { - "1446863752396800000": 6, - "1449400467456000000": 7 - } + "guild_scheduled_event_count": 122, + "guild_scheduled_event_exception_counts": { + "1446863752396800000": 6, + "1449400467456000000": 7 + } } ``` From 109159182742a2fd3577708cd2c605d23c0d2fb9 Mon Sep 17 00:00:00 2001 From: Droid <174426320+Droid00000@users.noreply.github.com> Date: Thu, 19 Feb 2026 20:52:56 -0500 Subject: [PATCH 4/4] Droid - Clarify that changing the recurrence_rule may delete exceptions --- developers/resources/guild-scheduled-event.mdx | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/developers/resources/guild-scheduled-event.mdx b/developers/resources/guild-scheduled-event.mdx index ed81075b40..047118a919 100644 --- a/developers/resources/guild-scheduled-event.mdx +++ b/developers/resources/guild-scheduled-event.mdx @@ -363,7 +363,7 @@ Get a guild scheduled event. Returns a [guild scheduled event](/developers/resou ## Modify Guild Scheduled Event /guilds/[\{guild.id\}](/developers/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/developers/resources/guild-scheduled-event#guild-scheduled-event-object) -Modify a guild scheduled event. Returns the modified [guild scheduled event](/developers/resources/guild-scheduled-event#guild-scheduled-event-object) object on success. Fires a [Guild Scheduled Event Update](/developers/events/gateway-events#guild-scheduled-event-update) Gateway event. +Modify a guild scheduled event. Returns the modified [guild scheduled event](/developers/resources/guild-scheduled-event#guild-scheduled-event-object) object on success. Fires a [Guild Scheduled Event Update](/developers/events/gateway-events#guild-scheduled-event-update) Gateway event, and optionally multiple [Guild Scheduled Event Exception Delete](/developers/events/gateway-events#guild-scheduled-event-exception-delete) Gateway events. To start or end an event, use this endpoint to modify the event's [status](/developers/resources/guild-scheduled-event#guild-scheduled-event-object-guild-scheduled-event-status) field. @@ -378,7 +378,11 @@ This endpoint silently discards `entity_metadata` for non-`EXTERNAL` events. -All parameters to this endpoint are optional +Modifying the `recurrence_rule` may cause all exceptions for an event to be removed. + + + +All parameters to this endpoint are optional. @@ -476,7 +480,7 @@ All parameters to this endpoint are optional. ## Delete Guild Scheduled Event Exception /guilds/[\{guild.id\}](/developers/resources/guild#guild-object)/scheduled-events/[\{guild_scheduled_event.id\}](/developers/resources/guild-scheduled-event#guild-scheduled-event-object)/exceptions/[\{exception.id\}](/developers/resources/guild-scheduled-event#guild-scheduled-event-exception-object) -Delete an exception for the guild scheduled event's recurrence rule. Returns a `204` on success. Fires a [Guild Scheduled Event Exception Delete](/developers/events/gateway-events#guild-scheduled-event-exception-delete) Gateway event. +Delete an exception for the guild scheduled event's recurrence rule. Returns a `204` empty response on success. Fires a [Guild Scheduled Event Exception Delete](/developers/events/gateway-events#guild-scheduled-event-exception-delete) Gateway event. This endpoint supports the `X-Audit-Log-Reason` header.