Create a Notetaker Configuration - Notetaker Configurations - API Reference

POST

https://api.us.nylas.com/v3/notetakers/configs

Creates a new configuration for the application. Configurations define reusable settings that Notetakers inherit through a hierarchical chain.

The scope of the configuration is determined by which context fields you provide:

application_id only → application scope
workspace_id → workspace scope
grant_id → grant scope. Grant configurations are policy-only: they support dispatch_disabled_until for dispatch suppression and reject notetaker_settings and deduplication_policy.
Other scopes (calendar, recurring event) are created automatically by the calendar and event sync endpoints.

workspace_id and grant_id are mutually exclusive.

To upload a custom video output image, send the request as multipart/form-data with the JSON body in a part named config and the image in a file part referenced by notetaker_settings.video_output.file_key. Small images (up to 1,376,256 decoded bytes) can be sent inline on application/json requests using video_output.media_type and video_output.data instead.

NYLAS API KEY

Request body

application_idstring

Optional. If provided, must match the application ID associated with your API key — Nylas infers the application from your credentials when this field is omitted.

Example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"

workspace_idstring

The workspace ID. Provide to create a workspace-scope configuration. Mutually exclusive with grant_id.

Example: "ws-12345"

grant_idstring

The grant ID. Provide to create a policy-only grant configuration for dispatch suppression. Grant configurations support only dispatch_disabled_until — requests that include notetaker_settings or deduplication_policy return 400 Bad Request. The configuration's config_id is the grant ID. Mutually exclusive with workspace_id.

Example: "e19f8e1a-eb1c-41c0-b6d6-a24a6a9d6b28"

display_namestring

A human-readable name to identify this configuration.

Example: "Company defaults"

notetaker_settingsobject

Flat Notetaker settings for the configuration system. All fields are optional — when omitted, the value is inherited from the parent configuration in the hierarchy.

Cannot be used together with the legacy name and meeting_settings fields.

deduplication_policystring

Controls whether Notetakers governed by this configuration participate in deduplication. Available values depend on the scope: application and workspace support active or inactive; calendar, event, and per-notetaker support inherit or disable.

activeinactiveinheritdisable

Example: "active"

dispatch_disabled_untilstring<date-time>nullable

An RFC 3339 timestamp that suppresses Notetaker dispatch while it's in the future. Accepted on application, workspace, and grant configurations. While active, Nylas rejects immediate join requests and doesn't dispatch scheduled Notetakers governed by this configuration. See Pause Notetaker dispatch.

Example: "2026-08-01T00:00:00Z"

Responses

request_idstring

The request ID.

dataobject

curl -X POST \ -H "Authorization: Bearer <NYLAS_API_KEY>" \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{ "application_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "workspace_id": "ws-12345", "grant_id": "e19f8e1a-eb1c-41c0-b6d6-a24a6a9d6b28" }' \ "https://api.us.nylas.com/v3/notetakers/configs"