Sample code for 30+ languages & platforms
PowerBuilder Requires Chilkat v11.6.0+

Outlook Calendar: Create, Rename, or Delete a Secondary Calendar

See more Outlook Calendar Examples

Select one operation: create (the default), rename, or delete. Creation returns an opaque calendar ID to save with the application record. To rename or delete, explicitly set that ID and change action. The example retrieves the calendar first and refuses to operate on the default calendar. Names are display labels and are not unique identifiers.

Live changes: rename changes the calendar name; delete removes the secondary calendar and its events. The operations are alternatives, not a create/rename/delete sequence. Never delete a calendar merely to clean up an example without checking its contents and ownership. Deletion succeeds with HTTP 204 and no JSON body.

Unlike event creation, calendar creation has no transactionId deduplication property. A private pending record is saved before sending; an uncertain outcome or failed receipt write blocks automatic repeat creation. Inspect the calendar list and reconcile that attempt first. Keep operation files per account, with a single writer. Use a new filename only for a deliberately new calendar. A completed receipt prevents accidental creation when rerunning the sample.

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.

Microsoft documentation

Chilkat PowerBuilder Downloads

PowerBuilder
integer li_rc
long li_Success
oleobject loo_Token
oleobject loo_Http
oleobject loo_Resp
oleobject loo_Result
string ls_Action
string ls_CalendarId
oleobject loo_Body
oleobject loo_Fac
string ls_ReceiptPath
oleobject loo_Operation
oleobject loo_Endpoint

li_Success = 0

//  Assumes Chilkat is unlocked. See Global Unlock Sample.
li_Success = 0
//  Obtain a delegated Microsoft Graph token using the calendar authorization example.
//  See Authorize Outlook Calendar with OAuth2 and PKCE.
loo_Token = create oleobject
li_rc = loo_Token.ConnectToNewObject("Chilkat.JsonObject")
if li_rc < 0 then
    destroy loo_Token
    MessageBox("Error","Connecting to COM object failed")
    return
end if
loo_Token.Strict = 1
li_Success = loo_Token.LoadFile("qa_data/tokens/outlookCalendar.json")
if li_Success <> 1 then
    Write-Debug "Could not read the private calendar token cache."
    destroy loo_Token
    return
end if

if (loo_Token.JsonTypeOf("access_token") <> 1) OR (loo_Token.StringOfEquals("access_token","",1) = 1) then
    Write-Debug "Expected a nonempty access_token in the JSON."
    destroy loo_Token
    return
end if

loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")

loo_Http.AuthToken = loo_Token.StringOf("access_token")
loo_Http.RequireSslCertVerify = 1
loo_Http.FollowRedirects = 0
loo_Http.ConnectTimeout = 20
loo_Http.ReadTimeout = 30
loo_Http.SetRequestHeader("Accept","application/json")
loo_Resp = create oleobject
li_rc = loo_Resp.ConnectToNewObject("Chilkat.HttpResponse")

loo_Result = create oleobject
li_rc = loo_Result.ConnectToNewObject("Chilkat.JsonObject")

loo_Result.Strict = 1
ls_Action = "create"//  Choose create, rename, or delete.
ls_CalendarId = "YOUR_SECONDARY_CALENDAR_ID"
if (ls_Action <> "create") AND (ls_Action <> "rename") AND (ls_Action <> "delete") then
    Write-Debug "Choose create, rename, or delete."
    destroy loo_Token
    destroy loo_Http
    destroy loo_Resp
    destroy loo_Result
    return
end if

loo_Body = create oleobject
li_rc = loo_Body.ConnectToNewObject("Chilkat.JsonObject")

loo_Fac = create oleobject
li_rc = loo_Fac.ConnectToNewObject("Chilkat.FileAccess")

if ls_Action = "create" then
    li_Success = loo_Fac.DirEnsureExists("qa_data/outlookCalendar")
    if li_Success <> 1 then
        Write-Debug "Could not create the private operation directory."
        destroy loo_Token
        destroy loo_Http
        destroy loo_Resp
        destroy loo_Result
        destroy loo_Body
        destroy loo_Fac
        return
    end if

    ls_ReceiptPath = "qa_data/outlookCalendar/secondary-calendar.json"
    loo_Operation = create oleobject
    li_rc = loo_Operation.ConnectToNewObject("Chilkat.JsonObject")

    loo_Operation.Strict = 1
    if loo_Fac.FileExists(ls_ReceiptPath) = 1 then
        li_Success = loo_Operation.LoadFile(ls_ReceiptPath)
        if li_Success <> 1 then
            Write-Debug "Could not read the previous operation; inspect it before retrying."
            destroy loo_Token
            destroy loo_Http
            destroy loo_Resp
            destroy loo_Result
            destroy loo_Body
            destroy loo_Fac
            destroy loo_Operation
            return
        end if

        if loo_Operation.StringOfEquals("status","created",1) = 1 then
            if (loo_Operation.JsonTypeOf("id") <> 1) OR (loo_Operation.StringOfEquals("id","",1) = 1) then
                Write-Debug "Expected a nonempty id in the JSON."
                destroy loo_Token
                destroy loo_Http
                destroy loo_Resp
                destroy loo_Result
                destroy loo_Body
                destroy loo_Fac
                destroy loo_Operation
                return
            end if

            Write-Debug "Already created calendar ID: " + loo_Operation.StringOf("id")
        else
            Write-Debug "Creation may already have occurred. Reconcile the calendar list before starting another operation."
        end if

        destroy loo_Token
        destroy loo_Http
        destroy loo_Resp
        destroy loo_Result
        destroy loo_Body
        destroy loo_Fac
        destroy loo_Operation
        return
    end if

    loo_Body.UpdateString("name","Secondary calendar")
    loo_Operation.UpdateString("status","pending")
    loo_Operation.UpdateString("name",loo_Body.StringOf("name"))
    //  Calendar creation has no event transactionId. Record an attempt before sending.
    li_Success = loo_Operation.WriteFile(ls_ReceiptPath)
    if li_Success <> 1 then
        Write-Debug "Could not record the creation attempt; no request sent."
        destroy loo_Token
        destroy loo_Http
        destroy loo_Resp
        destroy loo_Result
        destroy loo_Body
        destroy loo_Fac
        destroy loo_Operation
        return
    end if

    li_Success = loo_Http.HttpJson("POST","https://graph.microsoft.com/v1.0/me/calendars",loo_Body,"application/json",loo_Resp)
    //  A false result can still include an HTTP error response.
    if (li_Success <> 1) AND (loo_Resp.StatusCode = 0) then
        Write-Debug "No HTTP response was received. Inspect diagnostics privately; reconcile a write before retrying."
        destroy loo_Token
        destroy loo_Http
        destroy loo_Resp
        destroy loo_Result
        destroy loo_Body
        destroy loo_Fac
        destroy loo_Operation
        return
    end if

    if loo_Resp.StatusCode <> 201 then
        Write-Debug "Unexpected HTTP status: " + string(loo_Resp.StatusCode)
        Write-Debug "Request ID: " + loo_Resp.GetHeaderField("request-id")
        if loo_Resp.StatusCode = 429 then
            Write-Debug "Retry-After: " + loo_Resp.GetHeaderField("Retry-After")
        end if

        if loo_Resp.StatusCode = 401 then
            Write-Debug "Refresh the Graph access token or authorize again."
        end if

        destroy loo_Token
        destroy loo_Http
        destroy loo_Resp
        destroy loo_Result
        destroy loo_Body
        destroy loo_Fac
        destroy loo_Operation
        return
    end if

    li_Success = loo_Result.Load(loo_Resp.BodyStr)
    if li_Success <> 1 then
        Write-Debug "Expected a well-formed JSON response."
        destroy loo_Token
        destroy loo_Http
        destroy loo_Resp
        destroy loo_Result
        destroy loo_Body
        destroy loo_Fac
        destroy loo_Operation
        return
    end if

    if (loo_Result.JsonTypeOf("id") <> 1) OR (loo_Result.StringOfEquals("id","",1) = 1) then
        Write-Debug "Expected a nonempty id in the JSON."
        destroy loo_Token
        destroy loo_Http
        destroy loo_Resp
        destroy loo_Result
        destroy loo_Body
        destroy loo_Fac
        destroy loo_Operation
        return
    end if

    loo_Operation.UpdateString("id",loo_Result.StringOf("id"))
    loo_Operation.UpdateString("status","created")
    li_Success = loo_Operation.WriteFile(ls_ReceiptPath)
    if li_Success <> 1 then
        Write-Debug "Could not save the receipt. Reconcile the pending attempt before retrying."
        destroy loo_Token
        destroy loo_Http
        destroy loo_Resp
        destroy loo_Result
        destroy loo_Body
        destroy loo_Fac
        destroy loo_Operation
        return
    end if

    Write-Debug "Created calendar ID: " + loo_Result.StringOf("id")
    destroy loo_Token
    destroy loo_Http
    destroy loo_Resp
    destroy loo_Result
    destroy loo_Body
    destroy loo_Fac
    destroy loo_Operation
    return
end if

//  Use the saved ID for a deliberately selected secondary calendar.
loo_Endpoint = create oleobject
li_rc = loo_Endpoint.ConnectToNewObject("Chilkat.StringBuilder")

loo_Endpoint.Append("https://graph.microsoft.com/v1.0/me/calendars/")
loo_Endpoint.Append(loo_Http.UrlEncode(ls_CalendarId))
li_Success = loo_Http.HttpNoBody("GET",loo_Endpoint.GetAsString(),loo_Resp)
//  A false result can still include an HTTP error response.
if (li_Success <> 1) AND (loo_Resp.StatusCode = 0) then
    Write-Debug "No HTTP response was received. Inspect diagnostics privately; reconcile a write before retrying."
    destroy loo_Token
    destroy loo_Http
    destroy loo_Resp
    destroy loo_Result
    destroy loo_Body
    destroy loo_Fac
    destroy loo_Operation
    destroy loo_Endpoint
    return
end if

if loo_Resp.StatusCode <> 200 then
    Write-Debug "Unexpected HTTP status: " + string(loo_Resp.StatusCode)
    Write-Debug "Request ID: " + loo_Resp.GetHeaderField("request-id")
    if loo_Resp.StatusCode = 429 then
        Write-Debug "Retry-After: " + loo_Resp.GetHeaderField("Retry-After")
    end if

    if loo_Resp.StatusCode = 401 then
        Write-Debug "Refresh the Graph access token or authorize again."
    end if

    destroy loo_Token
    destroy loo_Http
    destroy loo_Resp
    destroy loo_Result
    destroy loo_Body
    destroy loo_Fac
    destroy loo_Operation
    destroy loo_Endpoint
    return
end if

li_Success = loo_Result.Load(loo_Resp.BodyStr)
if li_Success <> 1 then
    Write-Debug "Expected a well-formed JSON response."
    destroy loo_Token
    destroy loo_Http
    destroy loo_Resp
    destroy loo_Result
    destroy loo_Body
    destroy loo_Fac
    destroy loo_Operation
    destroy loo_Endpoint
    return
end if

if (loo_Result.JsonTypeOf("id") <> 1) OR (loo_Result.StringOfEquals("id","",1) = 1) then
    Write-Debug "Expected a nonempty id in the JSON."
    destroy loo_Token
    destroy loo_Http
    destroy loo_Resp
    destroy loo_Result
    destroy loo_Body
    destroy loo_Fac
    destroy loo_Operation
    destroy loo_Endpoint
    return
end if

if loo_Result.JsonTypeOf("isDefaultCalendar") <> 5 then
    Write-Debug "Expected isDefaultCalendar in the calendar response."
    destroy loo_Token
    destroy loo_Http
    destroy loo_Resp
    destroy loo_Result
    destroy loo_Body
    destroy loo_Fac
    destroy loo_Operation
    destroy loo_Endpoint
    return
end if

if loo_Result.BoolOf("isDefaultCalendar") = 1 then
    Write-Debug "This example operates only on secondary calendars."
    destroy loo_Token
    destroy loo_Http
    destroy loo_Resp
    destroy loo_Result
    destroy loo_Body
    destroy loo_Fac
    destroy loo_Operation
    destroy loo_Endpoint
    return
end if

if ls_Action = "rename" then
    loo_Body.UpdateString("name","Renamed calendar")
    li_Success = loo_Http.HttpJson("PATCH",loo_Endpoint.GetAsString(),loo_Body,"application/json",loo_Resp)
    //  A false result can still include an HTTP error response.
    if (li_Success <> 1) AND (loo_Resp.StatusCode = 0) then
        Write-Debug "No HTTP response was received. Inspect diagnostics privately; reconcile a write before retrying."
        destroy loo_Token
        destroy loo_Http
        destroy loo_Resp
        destroy loo_Result
        destroy loo_Body
        destroy loo_Fac
        destroy loo_Operation
        destroy loo_Endpoint
        return
    end if

    if loo_Resp.StatusCode <> 200 then
        Write-Debug "Unexpected HTTP status: " + string(loo_Resp.StatusCode)
        Write-Debug "Request ID: " + loo_Resp.GetHeaderField("request-id")
        if loo_Resp.StatusCode = 429 then
            Write-Debug "Retry-After: " + loo_Resp.GetHeaderField("Retry-After")
        end if

        if loo_Resp.StatusCode = 401 then
            Write-Debug "Refresh the Graph access token or authorize again."
        end if

        destroy loo_Token
        destroy loo_Http
        destroy loo_Resp
        destroy loo_Result
        destroy loo_Body
        destroy loo_Fac
        destroy loo_Operation
        destroy loo_Endpoint
        return
    end if

    li_Success = loo_Result.Load(loo_Resp.BodyStr)
    if li_Success <> 1 then
        Write-Debug "Expected a well-formed JSON response."
        destroy loo_Token
        destroy loo_Http
        destroy loo_Resp
        destroy loo_Result
        destroy loo_Body
        destroy loo_Fac
        destroy loo_Operation
        destroy loo_Endpoint
        return
    end if

    if (loo_Result.JsonTypeOf("id") <> 1) OR (loo_Result.StringOfEquals("id","",1) = 1) then
        Write-Debug "Expected a nonempty id in the JSON."
        destroy loo_Token
        destroy loo_Http
        destroy loo_Resp
        destroy loo_Result
        destroy loo_Body
        destroy loo_Fac
        destroy loo_Operation
        destroy loo_Endpoint
        return
    end if

    Write-Debug "Renamed calendar ID: " + loo_Result.StringOf("id")
else
    //  Live deletion removes this secondary calendar and its events.
    li_Success = loo_Http.HttpNoBody("DELETE",loo_Endpoint.GetAsString(),loo_Resp)
    //  A false result can still include an HTTP error response.
    if (li_Success <> 1) AND (loo_Resp.StatusCode = 0) then
        Write-Debug "No HTTP response was received. Inspect diagnostics privately; reconcile a write before retrying."
        destroy loo_Token
        destroy loo_Http
        destroy loo_Resp
        destroy loo_Result
        destroy loo_Body
        destroy loo_Fac
        destroy loo_Operation
        destroy loo_Endpoint
        return
    end if

    if loo_Resp.StatusCode <> 204 then
        Write-Debug "Unexpected HTTP status: " + string(loo_Resp.StatusCode)
        Write-Debug "Request ID: " + loo_Resp.GetHeaderField("request-id")
        if loo_Resp.StatusCode = 429 then
            Write-Debug "Retry-After: " + loo_Resp.GetHeaderField("Retry-After")
        end if

        if loo_Resp.StatusCode = 401 then
            Write-Debug "Refresh the Graph access token or authorize again."
        end if

        destroy loo_Token
        destroy loo_Http
        destroy loo_Resp
        destroy loo_Result
        destroy loo_Body
        destroy loo_Fac
        destroy loo_Operation
        destroy loo_Endpoint
        return
    end if

    Write-Debug "Secondary calendar deleted (HTTP 204)."
end if



destroy loo_Token
destroy loo_Http
destroy loo_Resp
destroy loo_Result
destroy loo_Body
destroy loo_Fac
destroy loo_Operation
destroy loo_Endpoint