Interface POSTCalendarEventBody

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)