Interface CreateCalendarEventOptions

interface CreateCalendarEventOptions {
    autofillWaitlist?: boolean;
    color?: number;
    description?: string;
    duration?: number;
    isAllDay?: boolean;
    isPrivate?: boolean;
    location?: string;
    name: string;
    roleIDs?: number[];
    rsvpLimit?: number;
    startsAt?: string;
    url?: string;
}

Properties

autofillWaitlist? color? description? duration? isAllDay? isPrivate? location? name roleIDs? rsvpLimit? startsAt? url?

Properties

OptionalautofillWaitlist

autofillWaitlist?: boolean

When rsvpLimit is set, users from the waitlist will be added as space becomes available in the event

Optionalcolor

color?: number

Event card's color.

Optionaldescription

description?: string

The description of the event.

Optionalduration

duration?: number

Event's duration in ms.

OptionalisAllDay

isAllDay?: boolean

Does the event last all day? If passed with duration, duration will only be applied if it is an interval of minutes represented in days (e.g., duration: 2880)

OptionalisPrivate

isPrivate?: boolean

If the event is private or not.

Optionallocation

location?: string

The location where the event will happen.

name

name: string

The name of the event.

OptionalroleIDs

roleIDs?: number[]

The role IDs to restrict the event to (min items 1; must have unique items true)

OptionalrsvpLimit

rsvpLimit?: number

Limit of member joining this event.

OptionalstartsAt

startsAt?: string

The event's starting date.

Optionalurl

url?: string

Link a URL to the event.

Settings

Member Visibility

On This Page

Properties