nylas
    Preparing search index...

    Interface SchedulerSettings

    interface SchedulerSettings {
        additionalFields?: Record<string, string>;
        availableDaysInFuture?: number;
        cancellationPolicy?: string;
        cancellationUrl?: string;
        confirmationRedirectUrl?: string;
        emailTemplate?: EmailTemplate;
        hideAdditionalGuests?: boolean;
        hideCancellationOptions?: boolean;
        hideReschedulingOptions?: boolean;
        minBookingNotice?: number;
        minCancellationNotice?: number;
        organizerConfirmationUrl?: string;
        reschedulingUrl?: string;
    }
    Index

    Properties

    additionalFields? availableDaysInFuture? cancellationPolicy? cancellationUrl? confirmationRedirectUrl? emailTemplate? hideAdditionalGuests? hideCancellationOptions? hideReschedulingOptions? minBookingNotice? minCancellationNotice? organizerConfirmationUrl? reschedulingUrl?

    Properties

    additionalFields?: Record<string, string>

    The definitions for additional fields to be displayed in the Scheduler UI. Guest will see the additional fields on the Scheduling Page when they book an event.

    availableDaysInFuture?: number

    The number of days in the future that Scheduler is available for scheduling events.

    cancellationPolicy?: string

    A message about the cancellation policy to display to users when booking an event.

    cancellationUrl?: string

    The URL used to cancel bookings. This URL is included in confirmation email messages.

    confirmationRedirectUrl?: string

    The custom URL to redirect to once the booking is confirmed.

    emailTemplate?: EmailTemplate

    Configurable settings for booking emails.

    hideAdditionalGuests?: boolean

    Whether to hide the Additional guests field on the Scheduling Page. If true, guests cannot invite additional guests to the event.

    hideCancellationOptions?: boolean

    If true, the option to cancel an event is hidden in booking confirmations and email notifications.

    hideReschedulingOptions?: boolean

    If true, the option to reschedule an event is hidden in booking confirmations and email notifications.

    minBookingNotice?: number

    The minimum number of minutes in the future that a user can make a new booking.

    minCancellationNotice?: number

    The minimum number of minutes before a booking can be cancelled.

    organizerConfirmationUrl?: string

    The URL used to confirm or cancel pending bookings. This URL is included in booking request email messages.

    reschedulingUrl?: string

    The URL used to reschedule bookings. This URL is included in confirmation email messages.

    Settings

    Member Visibility

    On This Page

    Properties