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 Go Downloads
success := false
// Assumes Chilkat is unlocked. See Global Unlock Sample.
success = false
// Obtain a delegated Microsoft Graph token using the calendar authorization example.
// See Authorize Outlook Calendar with OAuth2 and PKCE.
token := chilkat.NewJsonObject()
token.SetStrict(true)
success = token.LoadFile("qa_data/tokens/outlookCalendar.json")
if success != true {
fmt.Println("Could not read the private calendar token cache.")
token.DisposeJsonObject()
return
}
if (token.JsonTypeOf("access_token") != 1) || (token.StringOfEquals("access_token","",true) == true) {
fmt.Println("Expected a nonempty access_token in the JSON.")
token.DisposeJsonObject()
return
}
http := chilkat.NewHttp()
http.SetAuthToken(token.StringOf("access_token"))
http.SetRequireSslCertVerify(true)
http.SetFollowRedirects(false)
http.SetConnectTimeout(20)
http.SetReadTimeout(30)
http.SetRequestHeader("Accept","application/json")
resp := chilkat.NewHttpResponse()
result := chilkat.NewJsonObject()
result.SetStrict(true)
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.
requestFile := "qa_data/outlookCalendar/create-recurring-request.json"
resultFile := "qa_data/outlookCalendar/created-recurring.json"
fac := chilkat.NewFileAccess()
success = fac.DirEnsureExists("qa_data/outlookCalendar")
if success != true {
fmt.Println("Could not create the private operation directory.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
fac.DisposeFileAccess()
return
}
body := chilkat.NewJsonObject()
body.SetStrict(true)
if fac.FileExists(requestFile) == true {
success = body.LoadFile(requestFile)
if success != true {
fmt.Println("Could not read the saved create request; nothing sent.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
fac.DisposeFileAccess()
body.DisposeJsonObject()
return
}
// Retry the same saved body and transactionId after an uncertain result.
} else {
when := chilkat.NewCkDateTime()
success = when.SetFromCurrentSystemTime()
if success != true {
fmt.Println("Could not get the time.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
fac.DisposeFileAccess()
body.DisposeJsonObject()
when.DisposeCkDateTime()
return
}
success = when.AddDays(1)
if success != true {
fmt.Println("Could not calculate tomorrow.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
fac.DisposeFileAccess()
body.DisposeJsonObject()
when.DisposeCkDateTime()
return
}
body.UpdateString("subject","Recurring appointment")
body.UpdateString("body.contentType","text")
body.UpdateString("body.content","Sample event details.")
body.UpdateString("start.dateTime",*when.GetAsIso8601("YYYY-MM-DDThh:mm:ss",false))
body.UpdateString("start.timeZone","UTC")
success = when.AddSeconds(3600)
if success != true {
fmt.Println("Could not calculate the end.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
fac.DisposeFileAccess()
body.DisposeJsonObject()
when.DisposeCkDateTime()
return
}
body.UpdateString("end.dateTime",*when.GetAsIso8601("YYYY-MM-DDThh:mm:ss",false))
body.UpdateString("end.timeZone","UTC")
body.UpdateString("recurrence.pattern.type","daily")
body.UpdateInt("recurrence.pattern.interval",1)
body.UpdateString("recurrence.range.type","numbered")
body.UpdateInt("recurrence.range.numberOfOccurrences",3)
body.UpdateString("recurrence.range.recurrenceTimeZone","UTC")
recurrenceDate := chilkat.NewStringBuilder()
recurrenceDate.Append(*body.StringOf("start.dateTime"))
startDate := recurrenceDate.GetBefore("T",false)
body.UpdateString("recurrence.range.startDate",*startDate)
// No attendees: this is an appointment, so the request does not send invitations.
crypt := chilkat.NewCrypt2()
transactionId := crypt.GenerateUuid()
if crypt.LastMethodSuccess() != true {
fmt.Println("Could not create a transaction ID.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
fac.DisposeFileAccess()
body.DisposeJsonObject()
when.DisposeCkDateTime()
recurrenceDate.DisposeStringBuilder()
crypt.DisposeCrypt2()
return
}
body.UpdateString("transactionId",*transactionId)
success = body.WriteFile(requestFile)
if success != true {
fmt.Println("Could not save the request before sending; nothing sent.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
fac.DisposeFileAccess()
body.DisposeJsonObject()
when.DisposeCkDateTime()
recurrenceDate.DisposeStringBuilder()
crypt.DisposeCrypt2()
return
}
}
if (body.JsonTypeOf("transactionId") != 1) || (body.StringOfEquals("transactionId","",true) == true) {
fmt.Println("Expected a nonempty transactionId in the JSON.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
fac.DisposeFileAccess()
body.DisposeJsonObject()
when.DisposeCkDateTime()
recurrenceDate.DisposeStringBuilder()
crypt.DisposeCrypt2()
return
}
// A previous successful run leaves a small receipt. Do not submit it again.
if fac.FileExists(resultFile) == true {
receipt := chilkat.NewJsonObject()
receipt.SetStrict(true)
success = receipt.LoadFile(resultFile)
if success != true {
fmt.Println("Could not read the existing receipt; nothing sent.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
fac.DisposeFileAccess()
body.DisposeJsonObject()
when.DisposeCkDateTime()
recurrenceDate.DisposeStringBuilder()
crypt.DisposeCrypt2()
receipt.DisposeJsonObject()
return
}
if (receipt.JsonTypeOf("id") != 1) || (receipt.StringOfEquals("id","",true) == true) {
fmt.Println("Expected a nonempty id in the JSON.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
fac.DisposeFileAccess()
body.DisposeJsonObject()
when.DisposeCkDateTime()
recurrenceDate.DisposeStringBuilder()
crypt.DisposeCrypt2()
receipt.DisposeJsonObject()
return
}
if receipt.StringOfEquals("transactionId",*body.StringOf("transactionId"),true) != true {
fmt.Println("The receipt belongs to another operation; nothing sent.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
fac.DisposeFileAccess()
body.DisposeJsonObject()
when.DisposeCkDateTime()
recurrenceDate.DisposeStringBuilder()
crypt.DisposeCrypt2()
receipt.DisposeJsonObject()
return
}
fmt.Println("Already created event ID: ", *receipt.StringOf("id"))
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
fac.DisposeFileAccess()
body.DisposeJsonObject()
when.DisposeCkDateTime()
recurrenceDate.DisposeStringBuilder()
crypt.DisposeCrypt2()
receipt.DisposeJsonObject()
return
}
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 != true) && (resp.StatusCode() == 0) {
fmt.Println("No HTTP response was received. Inspect diagnostics privately; reconcile a write before retrying.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
fac.DisposeFileAccess()
body.DisposeJsonObject()
when.DisposeCkDateTime()
recurrenceDate.DisposeStringBuilder()
crypt.DisposeCrypt2()
receipt.DisposeJsonObject()
return
}
if resp.StatusCode() != 201 {
fmt.Println("Unexpected HTTP status: ", resp.StatusCode())
fmt.Println("Request ID: ", *resp.GetHeaderField("request-id"))
if resp.StatusCode() == 429 {
fmt.Println("Retry-After: ", *resp.GetHeaderField("Retry-After"))
}
if resp.StatusCode() == 401 {
fmt.Println("Refresh the Graph access token or authorize again.")
}
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
fac.DisposeFileAccess()
body.DisposeJsonObject()
when.DisposeCkDateTime()
recurrenceDate.DisposeStringBuilder()
crypt.DisposeCrypt2()
receipt.DisposeJsonObject()
return
}
success = result.Load(resp.BodyStr())
if success != true {
fmt.Println("Expected a well-formed JSON response.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
fac.DisposeFileAccess()
body.DisposeJsonObject()
when.DisposeCkDateTime()
recurrenceDate.DisposeStringBuilder()
crypt.DisposeCrypt2()
receipt.DisposeJsonObject()
return
}
if (result.JsonTypeOf("id") != 1) || (result.StringOfEquals("id","",true) == true) {
fmt.Println("Expected a nonempty id in the JSON.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
fac.DisposeFileAccess()
body.DisposeJsonObject()
when.DisposeCkDateTime()
recurrenceDate.DisposeStringBuilder()
crypt.DisposeCrypt2()
receipt.DisposeJsonObject()
return
}
saved := chilkat.NewJsonObject()
saved.UpdateString("id",*result.StringOf("id"))
saved.UpdateString("transactionId",*body.StringOf("transactionId"))
// Display the ID even if saving the receipt fails: the server has already created the event.
fmt.Println("Created event ID: ", *result.StringOf("id"))
success = saved.WriteFile(resultFile)
if success != true {
fmt.Println("The event was created, but its receipt could not be saved. Reconcile before retrying.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
fac.DisposeFileAccess()
body.DisposeJsonObject()
when.DisposeCkDateTime()
recurrenceDate.DisposeStringBuilder()
crypt.DisposeCrypt2()
receipt.DisposeJsonObject()
saved.DisposeJsonObject()
return
}
fmt.Println("Start: ", *result.StringOf("start.dateTime"), " (", *result.StringOf("start.timeZone"), ")")
fmt.Println("End: ", *result.StringOf("end.dateTime"), " (", *result.StringOf("end.timeZone"), ")")
fmt.Println("Event receipt saved.")
// Inspect occurrences only after the series ID has been recorded.
seriesId := result.StringOf("id")
utcStart := chilkat.NewStringBuilder()
utcStart.Append(*body.StringOf("start.dateTime"))
utcStart.Append("Z")
windowStart := utcStart.GetAsString()
rangeEnd := chilkat.NewCkDateTime()
success = rangeEnd.SetFromTimestamp(*windowStart)
if success != true {
fmt.Println("Could not parse the saved series start.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
fac.DisposeFileAccess()
body.DisposeJsonObject()
when.DisposeCkDateTime()
recurrenceDate.DisposeStringBuilder()
crypt.DisposeCrypt2()
receipt.DisposeJsonObject()
saved.DisposeJsonObject()
utcStart.DisposeStringBuilder()
rangeEnd.DisposeCkDateTime()
return
}
success = rangeEnd.AddDays(7)
if success != true {
fmt.Println("Could not set the instance range.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
fac.DisposeFileAccess()
body.DisposeJsonObject()
when.DisposeCkDateTime()
recurrenceDate.DisposeStringBuilder()
crypt.DisposeCrypt2()
receipt.DisposeJsonObject()
saved.DisposeJsonObject()
utcStart.DisposeStringBuilder()
rangeEnd.DisposeCkDateTime()
return
}
windowEnd := rangeEnd.GetAsTimestamp(false)
endpoint := chilkat.NewStringBuilder()
endpoint.Append("https://graph.microsoft.com/v1.0/me/events/")
endpoint.Append(*http.UrlEncode(*seriesId))
endpoint.Append("/instances?startDateTime=")
endpoint.Append(*http.UrlEncode(*windowStart))
endpoint.Append("&endDateTime=")
endpoint.Append(*http.UrlEncode(*windowEnd))
endpoint.Append("&$select=id,subject,start,end,type,seriesMasterId&$top=50")
url := endpoint.GetAsString()
nextLink := chilkat.NewStringBuilder()
seenLinks := chilkat.NewStringArray()
pageCount := 0
for (pageCount < 100) {
// Use Microsoft's nextLink exactly as returned; do not rebuild skip tokens.
nextLink.Clear()
nextLink.Append(*url)
if nextLink.StartsWith("https://graph.microsoft.com/v1.0/",true) != true {
fmt.Println("Unexpected pagination host or API version; no request sent.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
fac.DisposeFileAccess()
body.DisposeJsonObject()
when.DisposeCkDateTime()
recurrenceDate.DisposeStringBuilder()
crypt.DisposeCrypt2()
receipt.DisposeJsonObject()
saved.DisposeJsonObject()
utcStart.DisposeStringBuilder()
rangeEnd.DisposeCkDateTime()
endpoint.DisposeStringBuilder()
nextLink.DisposeStringBuilder()
seenLinks.DisposeStringArray()
return
}
if seenLinks.Find(*url,0) >= 0 {
fmt.Println("Repeated pagination URL; stopping.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
fac.DisposeFileAccess()
body.DisposeJsonObject()
when.DisposeCkDateTime()
recurrenceDate.DisposeStringBuilder()
crypt.DisposeCrypt2()
receipt.DisposeJsonObject()
saved.DisposeJsonObject()
utcStart.DisposeStringBuilder()
rangeEnd.DisposeCkDateTime()
endpoint.DisposeStringBuilder()
nextLink.DisposeStringBuilder()
seenLinks.DisposeStringArray()
return
}
seenLinks.Append(*url)
success = http.HttpNoBody("GET",*url,resp)
// A false result can still include an HTTP error response.
if (success != true) && (resp.StatusCode() == 0) {
fmt.Println("No HTTP response was received. Inspect diagnostics privately; reconcile a write before retrying.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
fac.DisposeFileAccess()
body.DisposeJsonObject()
when.DisposeCkDateTime()
recurrenceDate.DisposeStringBuilder()
crypt.DisposeCrypt2()
receipt.DisposeJsonObject()
saved.DisposeJsonObject()
utcStart.DisposeStringBuilder()
rangeEnd.DisposeCkDateTime()
endpoint.DisposeStringBuilder()
nextLink.DisposeStringBuilder()
seenLinks.DisposeStringArray()
return
}
if resp.StatusCode() != 200 {
fmt.Println("Unexpected HTTP status: ", resp.StatusCode())
fmt.Println("Request ID: ", *resp.GetHeaderField("request-id"))
if resp.StatusCode() == 429 {
fmt.Println("Retry-After: ", *resp.GetHeaderField("Retry-After"))
}
if resp.StatusCode() == 401 {
fmt.Println("Refresh the Graph access token or authorize again.")
}
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
fac.DisposeFileAccess()
body.DisposeJsonObject()
when.DisposeCkDateTime()
recurrenceDate.DisposeStringBuilder()
crypt.DisposeCrypt2()
receipt.DisposeJsonObject()
saved.DisposeJsonObject()
utcStart.DisposeStringBuilder()
rangeEnd.DisposeCkDateTime()
endpoint.DisposeStringBuilder()
nextLink.DisposeStringBuilder()
seenLinks.DisposeStringArray()
return
}
success = result.Load(resp.BodyStr())
if success != true {
fmt.Println("Expected a well-formed JSON response.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
fac.DisposeFileAccess()
body.DisposeJsonObject()
when.DisposeCkDateTime()
recurrenceDate.DisposeStringBuilder()
crypt.DisposeCrypt2()
receipt.DisposeJsonObject()
saved.DisposeJsonObject()
utcStart.DisposeStringBuilder()
rangeEnd.DisposeCkDateTime()
endpoint.DisposeStringBuilder()
nextLink.DisposeStringBuilder()
seenLinks.DisposeStringArray()
return
}
if result.JsonTypeOf("value") != 4 {
fmt.Println("Expected a value array.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
fac.DisposeFileAccess()
body.DisposeJsonObject()
when.DisposeCkDateTime()
recurrenceDate.DisposeStringBuilder()
crypt.DisposeCrypt2()
receipt.DisposeJsonObject()
saved.DisposeJsonObject()
utcStart.DisposeStringBuilder()
rangeEnd.DisposeCkDateTime()
endpoint.DisposeStringBuilder()
nextLink.DisposeStringBuilder()
seenLinks.DisposeStringArray()
return
}
i := 0
for (i < result.SizeOfArray("value")) {
result.SetI(i)
if (result.JsonTypeOf("value[i].id") != 1) || (result.StringOfEquals("value[i].id","",true) == true) {
fmt.Println("Expected a nonempty value[i].id in the JSON.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
fac.DisposeFileAccess()
body.DisposeJsonObject()
when.DisposeCkDateTime()
recurrenceDate.DisposeStringBuilder()
crypt.DisposeCrypt2()
receipt.DisposeJsonObject()
saved.DisposeJsonObject()
utcStart.DisposeStringBuilder()
rangeEnd.DisposeCkDateTime()
endpoint.DisposeStringBuilder()
nextLink.DisposeStringBuilder()
seenLinks.DisposeStringArray()
return
}
fmt.Println("Event ID: ", *result.StringOf("value[i].id"))
fmt.Println("Subject: ", *result.StringOf("value[i].subject"))
fmt.Println("Start: ", *result.StringOf("value[i].start.dateTime"), " (", *result.StringOf("value[i].start.timeZone"), ")")
fmt.Println("End: ", *result.StringOf("value[i].end.dateTime"))
fmt.Println("Type: ", *result.StringOf("value[i].type"))
i = i + 1
}
pageCount = pageCount + 1
// Quote the member name because @odata.nextLink contains a literal period.
nextType := result.JsonTypeOf("\"@odata.nextLink\"")
if (nextType == -1) || (nextType == 6) {
fmt.Println("Completed pages: ", pageCount)
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
fac.DisposeFileAccess()
body.DisposeJsonObject()
when.DisposeCkDateTime()
recurrenceDate.DisposeStringBuilder()
crypt.DisposeCrypt2()
receipt.DisposeJsonObject()
saved.DisposeJsonObject()
utcStart.DisposeStringBuilder()
rangeEnd.DisposeCkDateTime()
endpoint.DisposeStringBuilder()
nextLink.DisposeStringBuilder()
seenLinks.DisposeStringArray()
return
}
if (nextType != 1) || (result.StringOfEquals("\"@odata.nextLink\"","",true) == true) {
fmt.Println("Invalid continuation link; cannot establish completeness.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
fac.DisposeFileAccess()
body.DisposeJsonObject()
when.DisposeCkDateTime()
recurrenceDate.DisposeStringBuilder()
crypt.DisposeCrypt2()
receipt.DisposeJsonObject()
saved.DisposeJsonObject()
utcStart.DisposeStringBuilder()
rangeEnd.DisposeCkDateTime()
endpoint.DisposeStringBuilder()
nextLink.DisposeStringBuilder()
seenLinks.DisposeStringArray()
return
}
url = result.StringOf("\"@odata.nextLink\"")
}
fmt.Println("Stopped at the example's 100-page limit. Save the continuation URL privately to resume.")
token.DisposeJsonObject()
http.DisposeHttp()
resp.DisposeHttpResponse()
result.DisposeJsonObject()
fac.DisposeFileAccess()
body.DisposeJsonObject()
when.DisposeCkDateTime()
recurrenceDate.DisposeStringBuilder()
crypt.DisposeCrypt2()
receipt.DisposeJsonObject()
saved.DisposeJsonObject()
utcStart.DisposeStringBuilder()
rangeEnd.DisposeCkDateTime()
endpoint.DisposeStringBuilder()
nextLink.DisposeStringBuilder()
seenLinks.DisposeStringArray()