Skip to content
Skip to main content
POST
/v3/grants/{grant_id}/calendars

Create a calendar

Creates a calendar.

NYLAS API KEYACCESS TOKEN

Parameters

Path parameters

grant_id*string

ID of the grant to access. You can also use the email address associated with the grant, or use /me/ to refer to the grant associated with an access token.

Query parameters

selectstring

Specify fields that you want Nylas to return, as a comma-separated list (for example, select=id,updated_at). This allows you to receive only the portion of object data that you're interested in. You can use select to optimize response size and reduce latency by limiting queries to only the information that you need.

Request body

descriptionstring

(Not supported for iCloud or EWS) A brief description of the calendar.

Example: "Junior sports league carpool drivers"
locationstring

(Not supported for iCloud or EWS) The geographic location of the calendar, as free-form text.

Example: "London, England"
metadataobject

The metadata associated with the object. For more information, see Metadata.

name*string

The name of the calendar.

Example: "My New Calendar"
notetakerobject
timezonestring

(Google and virtual calendars only) An IANA timezone database formatted string (for example, America/New_York).

Example: "America/Los_Angeles"

Responses

request_idstring

The request ID.

dataobject

A Calendar object.

POSThttps://api.us.nylas.com/v3/grants/nyla%40example.com/calendars

Find your API key in the Nylas Dashboard under API Keys in your application settings.

grant_idrequiredstring

ID of the grant to access. You can also use the email address associated with the grant, or use /me/ to refer to the grant associated with an access token.

selectstring

Specify fields that you want Nylas to return, as a comma-separated list (for example, select=id,updated_at). This allows you to receive only the portion of object data that you're interested in. You can use select to optimize response size and reduce latency by limiting queries to only the information that you need.

Loading editor...

Autocomplete and validation come from this endpoint's request schema.