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

Outlook Calendar: Create an Appointment with a Transaction ID

See more Outlook Calendar Examples

Create a one-hour appointment 24 hours from the current time in the default calendar. Requires delegated Calendars.ReadWrite. The subject and body are generic, times are computed at runtime, and no attendees are included. Adding attendees changes this to a meeting and Graph sends invitations; setting a location name alone does not reserve a room.

The example saves the request and its transactionId before sending, then records the returned event ID in a receipt. After an uncertain response, reuse the same payload and transaction ID; do not generate a new UUID for each retry. A receipt prevents an already-successful demonstration run from posting again. For a deliberately new event, use a new pair of request/receipt filenames and a new transaction ID. Keep each operation tied to the same mailbox and serialize access. Production outboxes need durable, atomic storage; this sample does not implement a general retry scheduler or promise indefinite deduplication.

Input dateTime values are paired with timeZone="UTC". For local wall-clock scheduling, choose a mailbox-supported zone and handle daylight-saving transitions explicitly. The response preference requests UTC display and immutable event IDs; preserve the returned ID as a case-sensitive string for later reads or deletion. HTTP 201 confirms creation. A local receipt-write failure does not undo the server operation.

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 PHP ActiveX Downloads

PHP ActiveX
<?php

$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.
$token = new COM("Chilkat.JsonObject");
$token->Strict = 1;
$success = $token->LoadFile('qa_data/tokens/outlookCalendar.json');
if ($success != 1) {
    print 'Could not read the private calendar token cache.' . "\n";
    exit;
}

if (($token->JsonTypeOf('access_token') != 1) or ($token->StringOfEquals('access_token','',1) == 1)) {
    print 'Expected a nonempty access_token in the JSON.' . "\n";
    exit;
}

$http = new COM("Chilkat.Http");
$http->AuthToken = $token->stringOf('access_token');
$http->RequireSslCertVerify = 1;
$http->FollowRedirects = 0;
$http->ConnectTimeout = 20;
$http->ReadTimeout = 30;
$http->SetRequestHeader('Accept','application/json');
$resp = new COM("Chilkat.HttpResponse");
$result = new COM("Chilkat.JsonObject");
$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.
$requestFile = 'qa_data/outlookCalendar/create-event-request.json';
$resultFile = 'qa_data/outlookCalendar/created-event.json';
$fac = new COM("Chilkat.FileAccess");
$success = $fac->DirEnsureExists('qa_data/outlookCalendar');
if ($success != 1) {
    print 'Could not create the private operation directory.' . "\n";
    exit;
}

$body = new COM("Chilkat.JsonObject");
$body->Strict = 1;
if ($fac->FileExists($requestFile) == 1) {
    $success = $body->LoadFile($requestFile);
    if ($success != 1) {
        print 'Could not read the saved create request; nothing sent.' . "\n";
        exit;
    }

    //  Retry the same saved body and transactionId after an uncertain result.
}
else {
    $when = new COM("Chilkat.CkDateTime");
    $success = $when->SetFromCurrentSystemTime();
    if ($success != 1) {
        print 'Could not get the current time.' . "\n";
        exit;
    }

    $success = $when->AddSeconds(86400);
    if ($success != 1) {
        print 'Could not calculate the event start.' . "\n";
        exit;
    }

    $body->UpdateString('subject','Sample appointment');
    $body->UpdateString('body.contentType','text');
    $body->UpdateString('body.content','Sample event details.');
    $body->UpdateString('start.dateTime',$when->getAsIso8601('YYYY-MM-DDThh:mm:ss',0));
    $body->UpdateString('start.timeZone','UTC');
    $success = $when->AddSeconds(3600);
    if ($success != 1) {
        print 'Could not calculate the event end.' . "\n";
        exit;
    }

    $body->UpdateString('end.dateTime',$when->getAsIso8601('YYYY-MM-DDThh:mm:ss',0));
    $body->UpdateString('end.timeZone','UTC');
    $body->UpdateString('showAs','busy');
    $body->UpdateBool('isReminderOn',1);
    $body->UpdateInt('reminderMinutesBeforeStart',15);
    //  No attendees: this is an appointment, so the request does not send invitations.
    $crypt = new COM("Chilkat.Crypt2");
    $transactionId = $crypt->generateUuid();
    if ($crypt->LastMethodSuccess != 1) {
        print 'Could not create a transaction ID.' . "\n";
        exit;
    }

    $body->UpdateString('transactionId',$transactionId);
    $success = $body->WriteFile($requestFile);
    if ($success != 1) {
        print 'Could not save the request before sending; nothing sent.' . "\n";
        exit;
    }

}

if (($body->JsonTypeOf('transactionId') != 1) or ($body->StringOfEquals('transactionId','',1) == 1)) {
    print 'Expected a nonempty transactionId in the JSON.' . "\n";
    exit;
}

//  A previous successful run leaves a small receipt. Do not submit it again.
if ($fac->FileExists($resultFile) == 1) {
    $receipt = new COM("Chilkat.JsonObject");
    $receipt->Strict = 1;
    $success = $receipt->LoadFile($resultFile);
    if ($success != 1) {
        print 'Could not read the existing receipt; nothing sent.' . "\n";
        exit;
    }

    if (($receipt->JsonTypeOf('id') != 1) or ($receipt->StringOfEquals('id','',1) == 1)) {
        print 'Expected a nonempty id in the JSON.' . "\n";
        exit;
    }

    if ($receipt->StringOfEquals('transactionId',$body->stringOf('transactionId'),1) != 1) {
        print 'The receipt belongs to another operation; nothing sent.' . "\n";
        exit;
    }

    print 'Already created event ID: ' . $receipt->stringOf('id') . "\n";
    exit;
}

$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)) {
    print 'No HTTP response was received. Inspect diagnostics privately; reconcile a write before retrying.' . "\n";
    exit;
}

if ($resp->StatusCode != 201) {
    print 'Unexpected HTTP status: ' . $resp->StatusCode . "\n";
    print 'Request ID: ' . $resp->getHeaderField('request-id') . "\n";
    if ($resp->StatusCode == 429) {
        print 'Retry-After: ' . $resp->getHeaderField('Retry-After') . "\n";
    }

    if ($resp->StatusCode == 401) {
        print 'Refresh the Graph access token or authorize again.' . "\n";
    }

    exit;
}

$success = $result->Load($resp->BodyStr);
if ($success != 1) {
    print 'Expected a well-formed JSON response.' . "\n";
    exit;
}

if (($result->JsonTypeOf('id') != 1) or ($result->StringOfEquals('id','',1) == 1)) {
    print 'Expected a nonempty id in the JSON.' . "\n";
    exit;
}

$saved = new COM("Chilkat.JsonObject");
$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.
print 'Created event ID: ' . $result->stringOf('id') . "\n";
$success = $saved->WriteFile($resultFile);
if ($success != 1) {
    print 'The event was created, but its receipt could not be saved. Reconcile before retrying.' . "\n";
    exit;
}

print 'Start: ' . $result->stringOf('start.dateTime') . ' (' . $result->stringOf('start.timeZone') . ')' . "\n";
print 'End: ' . $result->stringOf('end.dateTime') . ' (' . $result->stringOf('end.timeZone') . ')' . "\n";
print 'Event receipt saved.' . "\n";

?>