Skip to content
Skip to main content
PUT
https://api.us.nylas.com/v3/grants/{grant_id}/settings/{setting_name}

Create or replace a grant setting

Creates the setting, or replaces it if it already exists. Send the value under the same key as setting_name. You don't need to know whether the grant already has a value, and retrying the same request is safe. What each setting accepts is in the request body schema.

NYLAS API KEY

Parameters

Path parameters

grant_id*string

ID of the grant to access.

Example: "5967ca40-a2d8-4ee0-a0e0-6f18ace39a90"
setting_name*string

The setting name. Request and response bodies use the same name as the JSON key.

synced-calendars

Request body

synced-calendars*array<string>

The calendar IDs to sync, from 1 to 50. Nylas syncs and sends calendar.* and event.* notifications for these calendars only, starting from the grant's next sync. It checks every ID against the grant's calendars before it saves anything, so use the provider's calendar IDs from GET /v3/grants/{grant_id}/calendars, not primary. To remove the list, delete the setting instead of sending an empty array.

minItems: 1maxItems: 50

Responses

request_idstring

The request ID.

dataobject

The grant's public settings. Each key is the setting name, the same as in the path. A setting that isn't set is null.

PUThttps://api.us.nylas.com/v3/grants/5967ca40-a2d8-4ee0-a0e0-6f18ace39a90/settings/{setting_name}

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

grant_idrequiredstring

ID of the grant to access.

setting_namerequiredstring

The setting name. Request and response bodies use the same name as the JSON key.

Loading editor...

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