NYnylas
Manage Grants

Create or replace a grant setting

Changed on

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.

put/v3/grants/{grant_id}/settings/{setting_name}

Request

Request body

synced-calendarsstring[] required

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.

Response

OK

request_idstring

The request ID.

Example response

{
  "data": {
    "synced-calendars": [
      "jane@example.com",
      "c_3a7d1e5b@group.calendar.google.com"
    ]
  }
}

Changes