Interface POSTCalendarEventBody

Hierarchy

  • POSTCalendarEventBody

Properties

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

Properties

Optional autofillWaitlist

autofillWaitlist?: boolean

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

Optional color

color?: number

The color of the event when viewing in the calendar (min 0; max 16777215)

Optional description

description?: string

The description of the event (min length 1; max length 8000)

Optional duration

duration?: number

The duration of the event in minutes (min 1)

Optional isAllDay

isAllDay?: boolean

Does the event last all day

Optional isPrivate

isPrivate?: boolean

Optional location

location?: string

The location of the event (min length 1; max length 8000)

name

name: string

The name of the event (min length 1; max length 60)

Optional repeatInfo

repeatInfo?: {
    endDate?: string;
    endsAfterOccurrences?: number;
    every?: {
        count: number;
        interval: "day" | "week" | "month" | "year";
    };
    on?: ("sunday" | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday")[];
    type: "once" | "everyDay" | "everyWeek" | "everyMonth" | "custom";
}

Type declaration

  • Optional endDate?: string

    The ISO 8601 timestamp that the event ends at. Used to control the end date of the event repeat (only used when type is custom; if used with endsAfterOccurrences, the earliest resultant date of the two will be used)

  • Optional endsAfterOccurrences?: number

    Used to control the end date of the event repeat (only used when type is custom; if used with endDate, the earliest resultant date of the two will be used) (max 24)

  • Optional every?: {
        count: number;
        interval: "day" | "week" | "month" | "year";
    }

    Apply further clarification to your events. This must have type set to custom

    • count: number

      How often between your interval the event should repeat. For example, 1 would be every interval, 2 would be every second occurrence of the interval

    • interval: "day" | "week" | "month" | "year"

      Coupled with count, this indicates the time range you are repeating your event over

  • Optional on?: ("sunday" | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday")[]

    Used to control the day of the week that the event should repeat on (only used when type is custom and when every.interval is week) (min items 1)

  • type: "once" | "everyDay" | "everyWeek" | "everyMonth" | "custom"

    How often you want your event to repeat (important note: this will repeat for the next 180 days unless custom is defined) (default once)

Optional roleIds

roleIds?: number[]

Optional rsvpLimit

rsvpLimit?: number

The number of RSVPs to allow before waitlisting RSVPs (min 1)

Optional startsAt

startsAt?: string

The ISO 8601 timestamp that the event starts at

Optional url

url?: string

A URL to associate with the event

Settings

Member Visibility

Theme

On This Page