Update a Notetaker Configuration - Notetaker Configurations - API Reference

PATCH

https://api.us.nylas.com/v3/notetakers/configs/{config_id}

Updates the specified configuration. Only the fields you include in the request body are changed; all other fields remain unchanged. Each update increments the configuration's version number.

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

Parameters

Path parameters

config_id*string

The ID of the configuration to access.

Example: "d4e78fca-2a90-4b6e-91c3-a7f2bcb0d498"

Request body

display_namestring

A human-readable name to identify this configuration.

Example: "Updated 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. Omit the field to leave the current value unchanged; send null to clear the suppression and resume dispatch. See Pause Notetaker dispatch.

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

Responses

request_idstring

The request ID.

dataobject

curl -X PATCH \ -H "Authorization: Bearer <NYLAS_API_KEY>" \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{ "display_name": "Updated company defaults", "notetaker_settings": { "name": "Acme Notetaker", "recording_type": "audio_video", "transcription": true }, "deduplication_policy": "active" }' \ "https://api.us.nylas.com/v3/notetakers/configs/<config_id>"