# Nylas Configurations API **Canonical:** https://apis.io/apis/nylas/nylas-configurations-api/ **Provider:** Nylas — https://apis.io/providers/nylas/ **Base URL:** https://api.us.nylas.com **Documentation:** https://developer.nylas.com/docs/reference/api/applications/ Nylas Configurations API is one of 40 APIs that [Nylas](https://apis.io/providers/nylas/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Configurations. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, a getting-started guide, authentication docs, and rate-limit docs. 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](/docs/reference/api/sessions/post-sessions/) that includes the Configuration object ID to create a session. ## Agent Accounts as the organizer The `grant_id` in the path can be an [Agent Account](/docs/v3/agent-accounts/) grant, which makes the Agent Account the organizer of the Configuration. Guests then book against the agent's own calendar and receive confirmation email from the agent's own address, with no OAuth connection involved. Two limits apply when an Agent Account is a participant: - Set `availability.calendar_ids` to `["primary"]` and `booking.calendar_id` to `"primary"`. Scheduler reads and writes the Agent Account's primary calendar only. - Round-robin Configurations aren't supported. An Agent Account can't be a host under `max-fairness` or `max-availability`, though one-on-one, collective, and group Configurations all work. The scopes table below covers Google and Microsoft grants. Agent Accounts have no OAuth token, so they authenticate with your API key alone. For the full walkthrough, see [Use Scheduler with Agent Accounts](/docs/v3/scheduler/agent-accounts/). ## 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/` | `/calendar.readonly` ☑️
`/calendar` | `Calendars.Read` ☑️
`Calendars.ReadWrite` | For more information about scopes, see [Using scopes to request user data](/docs/dev-guide/scopes/). ## Operations (5) | Method | Path | Summary | |---|---|---| | POST | `/v3/grants/{grant_id}/scheduling/configurations` | Create Configuration | | GET | `/v3/grants/{grant_id}/scheduling/configurations` | Return all Configuration objects | | GET | `/v3/grants/{grant_id}/scheduling/configurations/{configuration_id}` | Return a Configuration | | PUT | `/v3/grants/{grant_id}/scheduling/configurations/{configuration_id}` | Update Configuration | | DELETE | `/v3/grants/{grant_id}/scheduling/configurations/{configuration_id}` | Delete a Configuration | ## Machine-readable artifacts (17) - **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/nylas/refs/heads/main/openapi/nylas-configurations-api-openapi.yml - **APIReference** — https://developer.nylas.com/docs/reference/notifications/ - **Documentation** — https://developer.nylas.com/docs/v3/notifications/ - **Documentation** — https://developer.nylas.com/docs/ - **APIReference** — https://developer.nylas.com/docs/reference/api/ - **GettingStarted** — https://developer.nylas.com/docs/v3/getting-started/ - **Authentication** — https://developer.nylas.com/docs/v3/auth/ - **RateLimits** — https://developer.nylas.com/docs/dev-guide/platform/rate-limits/ - **ErrorCodes** — https://developer.nylas.com/docs/api/errors/ - **Pricing** — https://www.nylas.com/pricing/ - **Signup** — https://dashboard-v3.nylas.com/register - **StatusPage** — https://status.nylas.com/ - **SDKs** — https://github.com/nylas/nylas-nodejs - **SDKs** — https://github.com/nylas/nylas-python - **SDKs** — https://github.com/nylas/nylas-ruby - **SDKs** — https://github.com/nylas/nylas-java - **APIReference** — https://developer.nylas.com/docs/reference/api/application-level-templates/ ## Other Nylas APIs (12) - [Nylas Contacts API](https://apis.io/apis/nylas/nylas-contacts-api/) - [Nylas Drafts API](https://apis.io/apis/nylas/nylas-drafts-api/) - [Nylas Events API](https://apis.io/apis/nylas/nylas-events-api/) - [Nylas Messages API](https://apis.io/apis/nylas/nylas-messages-api/) - [Nylas Threads API](https://apis.io/apis/nylas/nylas-threads-api/) - [Nylas Notetaker API](https://apis.io/apis/nylas/nylas-notetaker-api/) - [Nylas Amazon SNS Notifications API](https://apis.io/apis/nylas/nylas-amazon-sns-notifications-api/) - [Nylas App migration API](https://apis.io/apis/nylas/nylas-app-migration-api/) - [Nylas Application-level templates API](https://apis.io/apis/nylas/nylas-application-level-templates-api/) - [Nylas Application-level workflows API](https://apis.io/apis/nylas/nylas-application-level-workflows-api/) - [Nylas Applications API](https://apis.io/apis/nylas/nylas-applications-api/) - [Nylas Attachments API](https://apis.io/apis/nylas/nylas-attachments-api/) ## Tags Configurations --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/nylas/nylas-configurations-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/nylas/.