NYnylas
Configurations

Update Configuration

Changed on

Updates the specified Configuration object.

A PUT request merges your request body into the existing Configuration. Settings you leave out keep their current values, including settings inside nested objects you include. A few fields are replaced as a whole instead:

  • scheduler.additional_fields: include every field you want to keep, not only the one you're adding or changing.
  • scheduler.notetaker_settings
  • Arrays, except participants, whose entries are merged by email.
put/v3/grants/{grant_id}/scheduling/configurations/{configuration_id}

Request

  • Base URL
    https://api.us.nylas.com
  • Auth
    HTTP bearer

Request body

OR

Example request

{
  "availability": {
    "availability_rules": {
      "default_open_hours": [
        {
          "days": [
            0,
            1,
            2
          ],
          "start": "10:00",
          "end": "14:00",
          "timezone": "America/Chicago",
          "exdates": [
            "2006-01-18"
          ]
        }
      ],
      "default_specific_time_availability": [
        {
          "date": "2025-12-25",
          "start": "09:00",
          "end": "13:00",
          "timezone": "America/Toronto"
        }
      ],
      "only_specific_time_availability": true
    }
  },
  "event_booking": {
    "booking_type": "booking",
    "description": "Come ready to talk philosophy!",
    "location": "Central Library, room 203",
    "notify_participants": true,
    "reminders": [
      {
        "email_subject": "Reminder: Annual Philosophy Club Meeting",
        "minutes_before_event": 30,
        "recipient": "host",
        "type": "email"
      }
    ],
    "timezone": "America/Chicago",
    "title": "Annual Philosophy Club Meeting"
  },
  "participants": [
    {
      "availability": {
        "open_hours": [
          {
            "days": [
              0,
              1,
              2
            ],
            "start": "10:00",
            "end": "14:00",
            "timezone": "America/Chicago",
            "exdates": [
              "2006-01-18"
            ]
          }
        ]
      },
      "email": "nyla@example.com",
      "name": "Nyla",
      "specific_time_availability": [
        {
          "date": "2025-08-21",
          "start": "09:00",
          "end": "17:00",
          "timezone": "America/Toronto"
        }
      ],
      "only_specific_time_availability": true,
      "timezone": "America/Toronto"
    }
  ],
  "scheduler": {
    "notetaker_settings": {
      "enabled": true,
      "show_ui_consent_message": true,
      "notetaker_name": "Sales Recording Bot",
      "meeting_settings": {
        "action_items": true,
        "action_items_settings": {
          "custom_instructions": "Only return the 5 most important action items."
        },
        "audio_recording": true,
        "leave_after_silence_seconds": 360,
        "summary": true,
        "summary_settings": {
          "custom_instructions": "Return this summary in the MEDPIC sales methodology."
        },
        "transcription": true,
        "video_recording": true,
        "transcription_settings": {
          "expected_languages": [
            "en",
            "es"
          ],
          "fallback_language": "en",
          "keywords": [
            "Nylas",
            "AssemblyAI"
          ],
          "use_speaker_names_as_keywords": true
        },
        "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
            }
          ]
        }
      }
    }
  }
}

Response

Configuration returned

OR

Example response

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

Changes

  • 0e71ff80a4ceRevision changes
    • info

      the request property default value Nylas Notetaker was removed

    • info

      the request property default value Nylas Notetaker was removed

  • a669a04b02baRevision changes
    • breaking

      the request property //// became required

    • breaking

      the request property //// became required

    • breaking

      the //// request property's min was increased to 5.00

    • breaking

      removed subschema #1: Auto-conferencing subschema #2: Google Meet subschema #3: Zoom Meeting subschema #4: Microsoft Teams subschema #5: Teams for Business subschema #6: Skype for Consumer subschema #7: Skype for Business subschema #8: WebEx subschema #9: GoToMeeting from the // request property oneOf list

    • info

      added subschema #1: Auto-conferencing subschema #2: Google Meet subschema #3: Zoom Meeting subschema #4: Microsoft Teams subschema #5: Teams for Business subschema #6: Skype for Consumer subschema #7: Skype for Business subschema #8: WebEx subschema #9: GoToMeeting subschema #10: Remove conferencing to the // request property anyOf list