Skip to main content
PATCH
/
guilds
/
{guild_id}
/
scheduled-events
/
{guild_scheduled_event_id}
cURL
curl --request PATCH \
  --url https://discord.com/api/v10/guilds/{guild_id}/scheduled-events/{guild_scheduled_event_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "<unknown>",
  "name": "<string>",
  "description": "<string>",
  "image": "<string>",
  "scheduled_start_time": "2023-11-07T05:31:56Z",
  "scheduled_end_time": "2023-11-07T05:31:56Z",
  "entity_type": "<unknown>",
  "privacy_level": 123,
  "channel_id": "<unknown>",
  "entity_metadata": {
    "location": "<string>"
  }
}
'
{
  "id": "<string>",
  "guild_id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "channel_id": "<unknown>",
  "creator_id": "<unknown>",
  "image": "<string>",
  "scheduled_start_time": "2023-11-07T05:31:56Z",
  "scheduled_end_time": "2023-11-07T05:31:56Z",
  "status": 123,
  "entity_type": 3,
  "entity_id": "<unknown>",
  "privacy_level": 123,
  "entity_metadata": {
    "location": "<string>"
  },
  "creator": {
    "id": "<string>",
    "username": "<string>",
    "avatar": "<string>",
    "discriminator": "<string>",
    "public_flags": 123,
    "flags": 0,
    "global_name": "<string>",
    "primary_guild": "<unknown>",
    "bot": true,
    "system": true,
    "banner": "<string>",
    "accent_color": 123,
    "avatar_decoration_data": "<unknown>",
    "collectibles": "<unknown>"
  },
  "user_count": 123,
  "user_rsvp": "<unknown>"
}

Authorizations

Authorization
string
header
required

Discord bot token

Path Parameters

guild_id
string<snowflake>
required
guild_scheduled_event_id
string<snowflake>
required

Body

application/json
status
name
string
Maximum string length: 100
description
string | null
Maximum string length: 1000
image
string | null
scheduled_start_time
string<date-time>
scheduled_end_time
string<date-time> | null
entity_type
null · enum<integer> · enum<integer> · enum<integer> · enum<integer>
Available options:
3
privacy_level
integer<int32>

the scheduled event is only accessible to guild members

channel_id
null | string<snowflake>
entity_metadata
object

Response

200 response for update_guild_scheduled_event

id
string<snowflake>
required
guild_id
string<snowflake>
required
name
string
required
description
string | null
required
channel_id
null | string<snowflake>
required
creator_id
null | string<snowflake>
required
image
string | null
required
scheduled_start_time
string<date-time>
required
scheduled_end_time
string<date-time> | null
required
status
required
entity_type
enum<integer>
required
Available options:
3
entity_id
null | string<snowflake>
required
privacy_level
integer<int32>
required

the scheduled event is only accessible to guild members

entity_metadata
object
required
creator
object
user_count
integer<int32>
user_rsvp
object