Set up group meetings

Group meetings let you host events with multiple guests. Unlike one-on-one meetings, group events are designed for collaborative scheduling where multiple attendees are invited to the same event.

Create a group Configuration

You can create a group Configuration using either the Scheduler API or the Scheduler Editor Component.

Create group Configuration using Scheduler API

Make a Create Configuration or Update Configuration request and set the type to group.

curl --request POST \
  --url "https://api.us.nylas.com/v3/grants/<NYLAS_GRANT_ID>/scheduling/configurations" \
  --header 'Accept: application/json, application/gzip' \
  --header 'Authorization: Bearer <NYLAS_API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Welcome to Yoga",
    "type": "group",
    "group_booking": {
      "booking_type": "booking",
      "calendar_id": "primary",
      "reminders": [
        {
          "type": "email",
          "minutes_before_event": 30,
          "recipient": "host"
        },
        {
          "type": "webhook",
          "minutes_before_event": 30
        }
      ]
    },
    "scheduler": {
      "available_days_in_future": 260,
      "hide_cancellation_options": false,
      "hide_reschedule_options": false,
      "min_booking_notice": 0,
      "min_cancellation_notice": 0
    }
  }'

Create group event using Scheduler Editor Component

To create a group event using the Scheduler Editor Component, include the enableEventTypes object and set the group property to true.

<html>
  <body>
    <nylas-scheduler-editor />

    <script type="module">
      // ...Scheduler Editor Configuration
      schedulerEditor.enableEventTypes= {
        one_on_one: true,
        collective: true,
        max_fairness: true,
        max_availability: true,
        group: true
      },
      ...
    </script>
  </body>
</html>

By default, Nylas enables all event types. You can disable specific event types by setting them to false in the Scheduler Editor Component. When you have more than one event type enabled, Nylas presents users with a dialog where they select the event type when they create an event.

Create a group event

When you create a group event, you also specify the maximum number of participants that can attend. By default, each group event’s capacity is 10.

You can create group events using either the Scheduler API or the Scheduler Editor.

Create group event using Scheduler API

Make a Create Group Event request and specify the settings for your event. The following example creates a recurring group event with a maximum capacity of 100 participants.

curl --request POST \
  --url "https://api.us.nylas.com/v3/grants/<NYLAS_GRANT_ID>/scheduling/configurations/<SCHEDULER_CONFIG_ID>/group-events" \
  --header 'Accept: application/json, application/gzip' \
  --header 'Authorization: Bearer <NYLAS_API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "Annual Philosophy Club Meeting",
    "busy": true,
    "participants": [
      {
        "name": "Leyah Miller",
        "email": "[email protected]",
        "is_organizer": true
      },
      {
        "name": "Nyla",
        "email": "[email protected]",
        "is_organizer": false
      }
    ],
    "description": "Come ready to talk philosophy!",
    "when": {
      "start_time": 1674604800,
      "end_time": 1722382420,
      "start_timezone": "America/New_York",
      "end_timezone": "America/New_York"
    },
    "location": "New York Public Library, Cave room",
    "recurrence": [
      "RRULE:FREQ=WEEKLY;BYDAY=MO",
      "EXDATE:20211011T000000Z"
    ],
    "capacity": 100
  }'

Create group event using Scheduler Editor

If your Configuration allows users to create multiple types of meetings, Nylas shows a dialog where you can select the type you want when you create an event. To create a group event, select Group / Class.

The Scheduler Editor UI displaying the Event Type screen.

After you select the event type, you fill out the event details and select Create to create the meeting.

The Scheduler Editor UI displaying the Event Information screen.