nylas
    Preparing search index...

    Interface CreateEventRequest

    Interface representing a request to create an event.

    interface CreateEventRequest {
        busy?: boolean;
        calendarId?: string;
        capacity?: number;
        conferencing?: Conferencing;
        description?: string;
        hideParticipants?: boolean;
        location?: string;
        metadata?: Record<string, unknown>;
        notetaker?: NotetakerSettings;
        participants?: Participant[];
        readOnly?: boolean;
        recurrence?: string[];
        reminders?: Reminders;
        title?: string;
        visibility?: "private" | "public";
        when: CreateWhen;
    }
    Index

    Properties

    busy? calendarId? capacity? conferencing? description? hideParticipants? location? metadata? notetaker? participants? readOnly? recurrence? reminders? title? visibility? when

    Properties

    busy?: boolean

    This value determines whether to show this event's time block as available on shared or public calendars.

    calendarId?: string

    Calendar ID of the event.

    capacity?: number

    The maximum number of participants that may attend the event.

    conferencing?: Conferencing

    Representation of conferencing details for events. Conferencing object can be in one of two formats (sub-objects):

    description?: string

    Description of the event.

    hideParticipants?: boolean

    Whether participants of the event should be hidden.

    location?: string

    Location of the event, such as a physical address or meeting room name.

    metadata?: Record<string, unknown>

    A list of key-value pairs storing additional data.

    notetaker?: NotetakerSettings

    Notetaker meeting bot settings

    participants?: Participant[]

    List of participants invited to the event. Participants may also be rooms or resources.

    readOnly?: boolean

    If the event participants are able to edit the event.

    recurrence?: string[]

    An list of RRULE and EXDATE strings.

    RFC-5545

    reminders?: Reminders

    A list of reminders to send for the event. If left empty or omitted, the event uses the provider defaults.

    title?: string

    Title of the event.

    visibility?: "private" | "public"

    Visibility of the event, if the event is private or public.

    when: CreateWhen

    Representation of time and duration for events. When object can be in one of four formats (sub-objects):

    Settings

    Member Visibility

    On This Page

    Properties