Interface GetAvailabilityRequest

Interface for a Nylas get availability request

Hierarchy

  • GetAvailabilityRequest

Properties

availabilityRules?: AvailabilityRules

The rules to apply when checking availability.

durationMinutes: number

The total number of minutes the event should last.

endTime: number

Unix timestamp for the end time to check availability for.

intervalMinutes?: number

Nylas checks from the nearest interval of the passed [startTime]. For example, to schedule 30-minute meetings ([durationMinutes]) with 15 minutes between them ([intervalMinutes]). If you have a meeting starting at 9:59, the API returns times starting at 10:00. 10:00-10:30, 10:15-10:45.

participants: AvailabilityParticipant[]

Participant details to check availability for.

roundTo?: number

The number of minutes to round the time slots to. This allows for rounding to any multiple of 5 minutes, up to a maximum of 60 minutes. The default value is set to 15 minutes. When this variable is assigned a value, it overrides the behavior of the roundTo30Minutes flag, if it was set.

roundTo30Minutes?: boolean

When set to true, the availability time slots will start at 30 minutes past or on the hour. For example, a free slot starting at 16:10 is considered available only from 16:30.

Deprecated

Use [roundTo] instead.

startTime: number

Unix timestamp for the start time to check availability for.

Generated using TypeDoc