Guild Scheduled Event

List Scheduled Events

GetAPIGuildScheduledEvents

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

import { listScheduledEvents } from "dressed";
const scheduledEvents = await listScheduledEvents(guildId, params?);

Create Scheduled Event

PostAPIGuildScheduledEvent

Create a guild scheduled event in the guild.

import { createScheduledEvent } from "dressed";
await createScheduledEvent(guildId, data);
Info

A guild can have a maximum of 100 events with SCHEDULED or ACTIVE status at any time.

Get Scheduled Event

GetAPIGuildScheduledEvent

Get a guild scheduled event.

import { getScheduledEvent } from "dressed";
const scheduledEvent = await getScheduledEvent(guildId, guildScheduledEventId, params?);

Modify Scheduled Event

PatchAPIGuildScheduledEvent

Modify a guild scheduled event.

import { modifyScheduledEvent } from "dressed";
await modifyScheduledEvent(guildId, guildScheduledEventId, data);
Info
  • To start or end an event, use this endpoint to modify the event's status field.
  • This endpoint silently discards entity_metadata for non-EXTERNAL events.

Delete Scheduled Event

DeleteAPIGuildScheduledEvent

Delete a guild scheduled event.

import { deleteScheduledEvent } from "dressed";
await deleteScheduledEvent(guildId, guildScheduledEventId);

Get Scheduled Event Users

GetAPIGuildScheduledEventUsers

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

import { getScheduledEventUsers } from "dressed";
const scheduledEventUsers = await getScheduledEventUsers(guildId, guildScheduledEventId, params?);