Outlook Calendar: Create a Recurring Event and List Its Instances
See more Outlook Calendar Examples
Create three daily one-hour appointments beginning tomorrow in UTC, then list the occurrences and exceptions for the next seven days. A recurring event combines a pattern with a range. Save the series-master ID separately from each occurrence ID. To modify one occurrence later, use that occurrence's ID; a change to the master applies to the series. The instances endpoint does not include cancelled occurrences.
UTC avoids ambiguous local clock times in this example. For a recurring appointment at a fixed local time, use a mailbox-supported time zone consistently in the start/end and recurrence range so daylight-saving transitions are interpreted by the calendar service.
Live creation: this posts a real calendar item. The request file is saved before sending, including its transactionId, and a receipt records the returned ID. Reuse the saved payload after an uncertain outcome; use a new filename pair for a deliberately new operation. A saved receipt prevents repeat creation on a later successful run. Keep request/receipt files private, per account, and use one writer. See the basic creation example for the same pattern.
Follow the complete @odata.nextLink, retain the same Prefer header on every page, and treat IDs as case-sensitive strings. The example checks the Graph host and repeated links, and has a 100-page demonstration limit. Save a continuation URL privately if a larger scan must resume.
Delegated permission: Calendars.ReadWrite.
Uses Microsoft Graph v1.0 in the global cloud with a delegated access token saved by the calendar OAuth2 example. Both personal Outlook.com accounts and Microsoft 365 work/school accounts with a mailbox can use this flow. The app registration must support the selected account type. A token for SMTP/IMAP/POP or another API is not a Graph token.
/me means the signed-in user and requires delegated authentication. An unattended Microsoft 365 service instead needs application permissions and administrator consent, and addresses an explicit mailbox through /users/{id-or-userPrincipalName}. That client-credentials flow does not apply to personal Outlook.com accounts. These samples target the global cloud; national clouds use different authority and Graph hosts.
HTTP methods can return false for an HTTP error as well as a connection failure. The code distinguishes those cases and checks the expected status before reading JSON. For 401, refresh the access token or authorize again; for 403, check permissions, mailbox access, and tenant policy. For 429, honor Retry-After before a bounded retry. Do not automatically repeat a write after an uncertain outcome. Keep detailed errors and calendar data private.
Chilkat Visual Basic 6.0 Downloads
Dim success As Long
success = 0
' Assumes Chilkat is unlocked. See Global Unlock Sample.
success = 0
' Obtain a delegated Microsoft Graph token using the calendar authorization example.
' See Authorize Outlook Calendar with OAuth2 and PKCE.
Dim token As New ChilkatJsonObject
token.Strict = 1
success = token.LoadFile("qa_data/tokens/outlookCalendar.json")
If (success <> 1) Then
Debug.Print "Could not read the private calendar token cache."
Exit Sub
End If
If ((token.JsonTypeOf("access_token") <> 1) Or (token.StringOfEquals("access_token","",1) = 1)) Then
Debug.Print "Expected a nonempty access_token in the JSON."
Exit Sub
End If
Dim http As New ChilkatHttp
http.AuthToken = token.StringOf("access_token")
http.RequireSslCertVerify = 1
http.FollowRedirects = 0
http.ConnectTimeout = 20
http.ReadTimeout = 30
http.SetRequestHeader "Accept","application/json"
Dim resp As New ChilkatHttpResponse
Dim result As New ChilkatJsonObject
result.Strict = 1
http.SetRequestHeader "Prefer","outlook.timezone=""UTC"", IdType=""ImmutableId"""
' Live write: creates an appointment in the signed-in user's default calendar.
' Keep one request file per logical operation and account. Do not run concurrent copies.
Dim requestFile As String
requestFile = "qa_data/outlookCalendar/create-recurring-request.json"
Dim resultFile As String
resultFile = "qa_data/outlookCalendar/created-recurring.json"
Dim fac As New CkFileAccess
success = fac.DirEnsureExists("qa_data/outlookCalendar")
If (success <> 1) Then
Debug.Print "Could not create the private operation directory."
Exit Sub
End If
Dim body As New ChilkatJsonObject
body.Strict = 1
If (fac.FileExists(requestFile) = 1) Then
success = body.LoadFile(requestFile)
If (success <> 1) Then
Debug.Print "Could not read the saved create request; nothing sent."
Exit Sub
End If
' Retry the same saved body and transactionId after an uncertain result.
Else
Dim when As New CkDateTime
success = when.SetFromCurrentSystemTime()
If (success <> 1) Then
Debug.Print "Could not get the time."
Exit Sub
End If
success = when.AddDays(1)
If (success <> 1) Then
Debug.Print "Could not calculate tomorrow."
Exit Sub
End If
success = body.UpdateString("subject","Recurring appointment")
success = body.UpdateString("body.contentType","text")
success = body.UpdateString("body.content","Sample event details.")
success = body.UpdateString("start.dateTime",when.GetAsIso8601("YYYY-MM-DDThh:mm:ss",0))
success = body.UpdateString("start.timeZone","UTC")
success = when.AddSeconds(3600)
If (success <> 1) Then
Debug.Print "Could not calculate the end."
Exit Sub
End If
success = body.UpdateString("end.dateTime",when.GetAsIso8601("YYYY-MM-DDThh:mm:ss",0))
success = body.UpdateString("end.timeZone","UTC")
success = body.UpdateString("recurrence.pattern.type","daily")
success = body.UpdateInt("recurrence.pattern.interval",1)
success = body.UpdateString("recurrence.range.type","numbered")
success = body.UpdateInt("recurrence.range.numberOfOccurrences",3)
success = body.UpdateString("recurrence.range.recurrenceTimeZone","UTC")
Dim recurrenceDate As New ChilkatStringBuilder
success = recurrenceDate.Append(body.StringOf("start.dateTime"))
Dim startDate As String
startDate = recurrenceDate.GetBefore("T",0)
success = body.UpdateString("recurrence.range.startDate",startDate)
' No attendees: this is an appointment, so the request does not send invitations.
Dim crypt As New ChilkatCrypt2
Dim transactionId As String
transactionId = crypt.GenerateUuid()
If (crypt.LastMethodSuccess <> 1) Then
Debug.Print "Could not create a transaction ID."
Exit Sub
End If
success = body.UpdateString("transactionId",transactionId)
success = body.WriteFile(requestFile)
If (success <> 1) Then
Debug.Print "Could not save the request before sending; nothing sent."
Exit Sub
End If
End If
If ((body.JsonTypeOf("transactionId") <> 1) Or (body.StringOfEquals("transactionId","",1) = 1)) Then
Debug.Print "Expected a nonempty transactionId in the JSON."
Exit Sub
End If
' A previous successful run leaves a small receipt. Do not submit it again.
If (fac.FileExists(resultFile) = 1) Then
Dim receipt As New ChilkatJsonObject
receipt.Strict = 1
success = receipt.LoadFile(resultFile)
If (success <> 1) Then
Debug.Print "Could not read the existing receipt; nothing sent."
Exit Sub
End If
If ((receipt.JsonTypeOf("id") <> 1) Or (receipt.StringOfEquals("id","",1) = 1)) Then
Debug.Print "Expected a nonempty id in the JSON."
Exit Sub
End If
If (receipt.StringOfEquals("transactionId",body.StringOf("transactionId"),1) <> 1) Then
Debug.Print "The receipt belongs to another operation; nothing sent."
Exit Sub
End If
Debug.Print "Already created event ID: " & receipt.StringOf("id")
Exit Sub
End If
success = http.HttpJson("POST","https://graph.microsoft.com/v1.0/me/events",body,"application/json",resp)
' A false result can still include an HTTP error response.
If ((success <> 1) And (resp.StatusCode = 0)) Then
Debug.Print "No HTTP response was received. Inspect diagnostics privately; reconcile a write before retrying."
Exit Sub
End If
If (resp.StatusCode <> 201) Then
Debug.Print "Unexpected HTTP status: " & resp.StatusCode
Debug.Print "Request ID: " & resp.GetHeaderField("request-id")
If (resp.StatusCode = 429) Then
Debug.Print "Retry-After: " & resp.GetHeaderField("Retry-After")
End If
If (resp.StatusCode = 401) Then
Debug.Print "Refresh the Graph access token or authorize again."
End If
Exit Sub
End If
success = result.Load(resp.BodyStr)
If (success <> 1) Then
Debug.Print "Expected a well-formed JSON response."
Exit Sub
End If
If ((result.JsonTypeOf("id") <> 1) Or (result.StringOfEquals("id","",1) = 1)) Then
Debug.Print "Expected a nonempty id in the JSON."
Exit Sub
End If
Dim saved As New ChilkatJsonObject
success = saved.UpdateString("id",result.StringOf("id"))
success = saved.UpdateString("transactionId",body.StringOf("transactionId"))
' Display the ID even if saving the receipt fails: the server has already created the event.
Debug.Print "Created event ID: " & result.StringOf("id")
success = saved.WriteFile(resultFile)
If (success <> 1) Then
Debug.Print "The event was created, but its receipt could not be saved. Reconcile before retrying."
Exit Sub
End If
Debug.Print "Start: " & result.StringOf("start.dateTime") & " (" & result.StringOf("start.timeZone") & ")"
Debug.Print "End: " & result.StringOf("end.dateTime") & " (" & result.StringOf("end.timeZone") & ")"
Debug.Print "Event receipt saved."
' Inspect occurrences only after the series ID has been recorded.
Dim seriesId As String
seriesId = result.StringOf("id")
Dim utcStart As New ChilkatStringBuilder
success = utcStart.Append(body.StringOf("start.dateTime"))
success = utcStart.Append("Z")
Dim windowStart As String
windowStart = utcStart.GetAsString()
Dim rangeEnd As New CkDateTime
success = rangeEnd.SetFromTimestamp(windowStart)
If (success <> 1) Then
Debug.Print "Could not parse the saved series start."
Exit Sub
End If
success = rangeEnd.AddDays(7)
If (success <> 1) Then
Debug.Print "Could not set the instance range."
Exit Sub
End If
Dim windowEnd As String
windowEnd = rangeEnd.GetAsTimestamp(0)
Dim endpoint As New ChilkatStringBuilder
success = endpoint.Append("https://graph.microsoft.com/v1.0/me/events/")
success = endpoint.Append(http.UrlEncode(seriesId))
success = endpoint.Append("/instances?startDateTime=")
success = endpoint.Append(http.UrlEncode(windowStart))
success = endpoint.Append("&endDateTime=")
success = endpoint.Append(http.UrlEncode(windowEnd))
success = endpoint.Append("&$select=id,subject,start,end,type,seriesMasterId&$top=50")
Dim url As String
url = endpoint.GetAsString()
Dim nextLink As New ChilkatStringBuilder
Dim seenLinks As New CkStringArray
Dim pageCount As Long
pageCount = 0
Do While (pageCount < 100)
' Use Microsoft's nextLink exactly as returned; do not rebuild skip tokens.
nextLink.Clear
success = nextLink.Append(url)
If (nextLink.StartsWith("https://graph.microsoft.com/v1.0/",1) <> 1) Then
Debug.Print "Unexpected pagination host or API version; no request sent."
Exit Sub
End If
If (seenLinks.Find(url,0) >= 0) Then
Debug.Print "Repeated pagination URL; stopping."
Exit Sub
End If
success = seenLinks.Append(url)
success = http.HttpNoBody("GET",url,resp)
' A false result can still include an HTTP error response.
If ((success <> 1) And (resp.StatusCode = 0)) Then
Debug.Print "No HTTP response was received. Inspect diagnostics privately; reconcile a write before retrying."
Exit Sub
End If
If (resp.StatusCode <> 200) Then
Debug.Print "Unexpected HTTP status: " & resp.StatusCode
Debug.Print "Request ID: " & resp.GetHeaderField("request-id")
If (resp.StatusCode = 429) Then
Debug.Print "Retry-After: " & resp.GetHeaderField("Retry-After")
End If
If (resp.StatusCode = 401) Then
Debug.Print "Refresh the Graph access token or authorize again."
End If
Exit Sub
End If
success = result.Load(resp.BodyStr)
If (success <> 1) Then
Debug.Print "Expected a well-formed JSON response."
Exit Sub
End If
If (result.JsonTypeOf("value") <> 4) Then
Debug.Print "Expected a value array."
Exit Sub
End If
Dim i As Long
i = 0
Do While (i < result.SizeOfArray("value"))
result.I = i
If ((result.JsonTypeOf("value[i].id") <> 1) Or (result.StringOfEquals("value[i].id","",1) = 1)) Then
Debug.Print "Expected a nonempty value[i].id in the JSON."
Exit Sub
End If
Debug.Print "Event ID: " & result.StringOf("value[i].id")
Debug.Print "Subject: " & result.StringOf("value[i].subject")
Debug.Print "Start: " & result.StringOf("value[i].start.dateTime") & " (" & result.StringOf("value[i].start.timeZone") & ")"
Debug.Print "End: " & result.StringOf("value[i].end.dateTime")
Debug.Print "Type: " & result.StringOf("value[i].type")
i = i + 1
Loop
pageCount = pageCount + 1
' Quote the member name because @odata.nextLink contains a literal period.
Dim nextType As Long
nextType = result.JsonTypeOf("""@odata.nextLink""")
If ((nextType = -1) Or (nextType = 6)) Then
Debug.Print "Completed pages: " & pageCount
Exit Sub
End If
If ((nextType <> 1) Or (result.StringOfEquals("""@odata.nextLink""","",1) = 1)) Then
Debug.Print "Invalid continuation link; cannot establish completeness."
Exit Sub
End If
url = result.StringOf("""@odata.nextLink""")
Loop
Debug.Print "Stopped at the example's 100-page limit. Save the continuation URL privately to resume."