NYnylas
Notetaker Configurations

Update a Notetaker Configuration

Changed on

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.

patch/v3/notetakers/configs/{config_id}

Request

Request body

display_namestring

A human-readable name to identify this configuration.

deduplication_policy'active' | 'inactive'

Controls deduplication for this application or workspace configuration.

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 request

{
  "display_name": "Updated company defaults",
  "notetaker_settings": {
    "name": "Acme Notetaker",
    "recording_type": "audio_video",
    "transcription": true,
    "transcription_settings": {
      "expected_languages": [
        "en",
        "es"
      ],
      "fallback_language": "en",
      "keywords": [
        "Nylas",
        "AssemblyAI"
      ],
      "use_speaker_names_as_keywords": true
    },
    "summary": true,
    "summary_settings": {
      "custom_instructions": "Summarize in bullet points."
    },
    "action_items": true,
    "action_items_settings": {
      "custom_instructions": "Only return the 5 most important action items."
    },
    "leave_after_silence_seconds": 600,
    "messages": {
      "on_join": [
        {
          "type": "text",
          "content": "👋 Hey team! I'm your AI notetaker — here to capture the key points.",
          "send_after_ms": 5000
        }
      ],
      "on_participant_join": [
        {
          "type": "text",
          "content": "👋 Welcome! Recording and transcription are running.",
          "debounce_ms": 3000
        }
      ]
    },
    "video_output": {
      "file_key": "avatar",
      "media_type": "image/png",
      "data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg==",
      "size": 184320,
      "preview_url": "https://storage.googleapis.com/...",
      "preview_url_expires_at": 1786128794
    },
    "retention_time": 604800
  },
  "deduplication_policy": "active",
  "dispatch_disabled_until": "2026-08-01T00:00:00Z"
}

Response

Success. Returns the configuration.

request_idstring

The request ID.

Example response

{
  "request_id": "5fa64c92-e840-4357-86b9-2aa364d35b88"
}

Changes

  • a669a04b02baRevision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property type changed from object to no type

    • warning

      removed from the request property allOf list

    • info

      added subschema #2 to the request property anyOf list

  • 763d6b969cd7Revision changes
    • info

      added the optional property / to the response with the status