Version:
Only show these results:

Create grants for virtual calendars

Virtual calendars are Nylas' implementation of a calendar and events provider. Functionally, you can think of them as another provider like Google or Microsoft, but one that is limited to calendaring only. You can access virtual calendars using a connector just like any other provider, and use the same Calendar and Events APIs to interact with them.

Virtual calendars are ideal for situations where you need to schedule events for people or objects that aren’t associated with an existing Calendar account. Virtual calendars allow you to provide scheduling functionality to your users without requiring them to connect a third-party service provider like Google, Exchange, or Office 365.

For more details, see the Virtual Calendars documentation.

Set up a virtual calendar

The following sections describe how to set up a virtual calendar in Nylas v3.

Create a v3 Nylas connector

Nylas connectors store information that allows your Nylas application to connect to service providers. In this case the provider is Nylas, and you specify virtual-calendar to indicate that:

{
"name": "My New App",
"provider": "virtual-calendar"
}

⚠️ Virtual calendars do not support the concept of "scopes" (levels of access), so do not include any during the authentication process.

See the POST /v3/connectors reference documentation for more information on creating a connector.

Create a grant

Next, you must create a grant representing the account or end user that the virtual calendar is for. You must specify an identifier when you create a grant. This can be any string, though it may be helpful to use an email address.

⚠️ Some endpoints (such as the Availability endpoint) include validation that relies on the grant associated with an email address. If there are multiple grants associated with a single email address in your Nylas application, this validation might fail. To avoid this, use a unique email address or identifier when creating a grant for a virtual calendar, especially if it is for an end user who is using other Nylas features.

{
"provider": "virtual-calendar",
"settings": {
"email": "[email protected]"
}
}

See the POST /v3/grants reference documentation for more information on creating a grant.

What's next?

When you have authentication set up, you're done! You can now start using virtual calendars just as you would any other provider.