Update a group event - Group Events - API Reference

PUT

/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.

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>

curl --compressed --request PUT \ --url "https://api.us.nylas.com/v3/grants/<NYLAS_GRANT_ID>/scheduling/configurations/<SCHEDULER_CONFIGURATION_ID>/group-events/<EVENT_ID>" \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <NYLAS_API_KEY>' \ --header 'Content-Type: application/json' \ --data '{ "scheduler": { "rescheduling_url": "<RESCHEDULING_PAGE_URL>", "cancellation_url": "<CANCELLATION_PAGE_URL>" } }'