Update a group event - Group Events - API Reference

PUT

https://api.us.nylas.com/v3/grants/{grant_id}/scheduling/configurations/{configuration_id}/group-events/{event_id}

Updates the specified group event.

When you make a PUT request, Nylas replaces all data in the nested object with the information included in your request. For more information, see Updating objects.

NYLAS API KEY

Parameters

Path parameters

grant_id*string

The ID of the grant to access. Use /me/ to refer to the grant associated with an access token.

configuration_id*string

The ID of the Configuration object to access.

event_id*string

The ID of the group event to access.

Request body

Update a group event

calendar_idstring

The ID of the calendar to access.

Example: "primary"

capacityinteger

The maximum number of attendees allowed in the event.

Default: 10

Example: 50

min: 1max: 500

conferencingobject

An object that lets you automatically create a conference, or enter conferencing details manually.

provider*string

The conferencing provider that Nylas uses to create the conference. Teams for Business is available for Microsoft grants only.

Google MeetZoom MeetingMicrosoft TeamsTeams for Business

autocreate*object

When you include autocreate in your request, Nylas automatically creates the conference for the event and appends the conferencing details to the event description.

If the provider is Zoom Meeting, your Zoom OAuth app must include the following granular scopes for Nylas to manage meetings on behalf of the user:

meeting:write:meeting — required to create Zoom meetings.
meeting:update:meeting — required to update Zoom meetings (for example, when event time or title changes).
meeting:delete:meeting — required to delete Zoom meetings (when events are removed).

If any of these scopes are missing, the Zoom API rejects the request. After adding scopes to your Zoom app, affected users must re-authenticate their grant so their access tokens include the new scopes.

descriptionstring

A brief description of the group event (for example, its agenda). Nylas might return the description as an HTML string, depending on how the provider formats it.

Example: "Come ready to talk philosophy today!"

locationstring

The location of the group event (for example, a physical address or the name of a meeting room).

Example: "New York Public Library, Cave Room"

maxLength: 255

participantsobject

A list of participants to be included in the group event.

titlestring

The name of the event.

Example: "Annual Philosophy Club Meeting"

maxLength: 1024

whenobject

An object representing the time and duration of the group event.

Responses

request_idstring

The request ID.

dataarray<object>

Array items:

capacityinteger

(Not supported for EWS events) The maximum number of attendees allowed in the event.

Default: 10

Example: 50

min: 1max: 500

conferencingobject

An object that lets you automatically create a conference, or enter conferencing details manually.

You can't use autocreate and details in the same request. If you do, Nylas returns an error.

Nylas stores conference information in the event description. To remove conference details, set conferencing to {} and remove the corresponding conference information from the description in the same request.

descriptionstring

A brief description of the group event (for example, its agenda). Nylas might return the description as an HTML string, depending on how the provider formats it.

For Google accounts, this field accepts a maximum of 8,192 characters.

Example: "Come ready to talk philosophy!"

locationstring

The location of the group event (for example, a physical address or the name of a meeting room).

Example: "New York Public Library, Cave Room"

maxLength: 255

participants*array<object>

recurrencearray<string>

An array of RRULE and EXDATE strings. Nylas includes this field only if the event is the main (master) event. See RFC-5545 for more details. You can use this tool to learn more about the RRULE spec.

Events inherit their timezone from the when object. Nylas recommends that you use the when object to specify the event's start and end time.

Provider specifics:

Agent Accounts and virtual calendars don't support DTSTART or TZID. Nylas uses the event's when values as the start of the series instead.
iCloud accounts do not support recurring events for group events
Microsoft Graph adds one day to the UNTIL date.

Example: ["RRULE:FREQ=WEEKLY;BYDAY=MO","EXDATE:20210405T000000Z"]

remindersobject

A list of reminders to generate for the event. If not defined, Nylas uses the provider's default settings.

titlestring

The name of the event.

Example: "Annual Philosophy Club Meeting"

maxLength: 1024

when*object

The time and duration of the event.