NYnylas
Calendar

Update a calendar

Changed on

Updates the specified calendar.

When you make a PUT request, Nylas replaces all data in the nested object with the information included in your request. For more information, see Updating objects.

put/v3/grants/{grant_id}/calendars/{calendar_id}

Request

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

Query parameters

selectstring

Specify fields that you want Nylas to return, as a comma-separated list (for example, select=id,updated_at). This allows you to receive only the portion of object data that you're interested in. You can use select to optimize response size and reduce latency by limiting queries to only the information that you need.

Request body

descriptionstring

(Not supported for iCloud or EWS) A brief description of the calendar.

hex_colorstring

(Not supported for iCloud or EWS) The background color of the calendar, in hexadecimal format (for example, #0099EE). When empty, Nylas uses the default background color.

You can set or modify this value using a PUT request only.

hex_foreground_colorstring

(Google only) The foreground color of the calendar, in hexadecimal format (for example, #0099EE). When empty, Nylas uses the default foreground color.

You can modify this value using a PUT request only.

locationstring

(Not supported for iCloud or EWS) The geographic location of the calendar, as free-form text.

metadataMetadata

The metadata associated with the object. For more information, see Metadata.

namestring

The name of the calendar.

Microsoft doesn't allow you to update the name of a user's primary calendar.

timezonestring

(Google, Agent Accounts, and virtual calendars only) An IANA timezone database formatted string (for example, America/New_York).

Example request

{
  "description": "Junior sports league carpool drivers",
  "hex_color": "#039BE5",
  "hex_foreground_color": "#039BE5",
  "location": "London, England",
  "name": "My Updated Calendar",
  "timezone": "America/Los_Angeles",
  "notetaker": {
    "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
    },
    "config_id": "d4e78fca-2a90-4b6e-91c3-a7f2bcb0d498",
    "autocreate": true,
    "deduplication_policy": "inherit",
    "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
          }
        ]
      }
    },
    "name": "Nylas Notetaker",
    "rules": {
      "event_selection": [
        "internal",
        [
          "own_events",
          "external"
        ]
      ],
      "participant_filter": {
        "participants_gte": 5,
        "participants_lte": 5
      }
    }
  }
}

Response

Calendar Response

request_idstring

The request ID.

Example response

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

Changes