Skip to content
Skip to main content

Configurations

A configuration is a collection of event settings and preferences. Nylas Scheduler stores Configuration objects in the Scheduler database and loads them as Scheduling Pages in the Scheduler UI.

A configuration can be either private if it uses a session, or public if it does not. By default, Nylas creates public configurations (requires_session_auth: false). To create a private configuration, set requires_session_auth to true.

After you create a private configuration, you can make a POST /v3/scheduling/sessions request that includes the Configuration object ID to create a session.

Configurations scopes

The table below lists the Configurations endpoints and which scopes they require. The table shortens the full scope URI for space reasons, so add the prefix for the provider when requesting scopes.

The ☑️ in each column indicates the most restrictive scope you can request for each provider and still use that API. More permissive scopes appear under the minimum option. If you're already using one of the permissive scopes, you don't need to add the more restrictive scope.

Endpoint Google Scopes
https://www.googleapis.com/auth/...		 Microsoft Scopes
https://graph.microsoft.com/...
POST /scheduling/configurations
PUT /scheduling/configuration/<SCHEDULER_CONFIG_ID>		 /calendar.readonly ☑️
/calendar		 Calendars.Read ☑️
Calendars.ReadWrite

For more information about scopes, see Using scopes to request user data.

Endpoints

5
GET
Return all Configuration objects
GET /v3/grants/{grant_id}/scheduling/configurations

Returns all Configuration objects.

POST
Create Configuration
POST /v3/grants/{grant_id}/scheduling/configurations

Creates a Configuration object that you use to define settings and preferences for a scheduling session. Duplicate email notifications If the organizer in a scheduling session is a Microsoft account u...

GET
Return a Configuration
GET /v3/grants/{grant_id}/scheduling/configurations/{configuration_id}

Returns the specified Configuration object.

PUT
Update Configuration
PUT /v3/grants/{grant_id}/scheduling/configurations/{configuration_id}

Updates the specified Configuration object. 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...

DELETE
Delete a Configuration
DELETE /v3/grants/{grant_id}/scheduling/configurations/{configuration_id}

Deletes the specified Configuration object. You can't delete a Configuration that has active sessions.