PHP Extension

Outlook Contacts Update (PATCH) a Contact

See more Outlook Contact Examples

Update the properties of an Outlook contact object. PHP Extension

<?php

include("chilkat.php");

$success = false;

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$http = new CkHttp();

// Use your previously obtained access token here: Get Outlook Contacts OAuth2 Access Token (Azure AD v2.0 Endpoint).

$jsonToken = new CkJsonObject();
$success = $jsonToken->LoadFile('qa_data/tokens/outlookContacts.json');
if ($success == false) {
    print $jsonToken->lastErrorText() . "\n";
    exit;
}

$http->put_AuthToken($jsonToken->stringOf('access_token'));

// Send the following PATCH:

// PATCH https://graph.microsoft.com/v1.0/me/contacts/{id}
// Content-type: application/json
// Content-length: 1977
// 
// {
//   "homeAddress": {
//     "street": "123 Some street",
//     "city": "Seattle",
//     "state": "WA",
//     "postalCode": "98121"
//   },
//   "birthday": "1974-07-22"
// }

// Build the JSON body of the POST.

// Use this online tool to generate code from sample JSON: 
// Generate Code to Create JSON

$json = new CkJsonObject();
$json->UpdateString('homeAddress.street','123 Some street');
$json->UpdateString('homeAddress.city','Seattle');
$json->UpdateString('homeAddress.state','WA');
$json->UpdateString('homeAddress.postalCode','98121');
$json->UpdateString('birthday','1974-07-22');

// We need the ID of the contact to be updated.
// This was available in the response when we created the contact:  Create an Outlook Contact.
// Or you can list contacts to get the ID: List Outlook Contacts).

$id = 'AAMkADYzZWE3YmZmLWU0YzgtNGNkZC04MGE1LWFiYTFlNTRlY2QwYQBGAAAAAAAu7cUXL5YOTrdsUIw7-v8FBwBUcG0qWqkmQYqWLHQataQxAAAAAAEOAABUcG0qWqkmQYqWLHQataQxAAD0sxexAAA=';
$http->SetUrlVar('id',$id);

// Send the HTTP PATCH
$resp = new CkHttpResponse();
$success = $http->HttpJson('PATCH','https://graph.microsoft.com/v1.0/me/contacts/{$id}',$json,'application/json',$resp);
if ($success == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

print 'Response status code = ' . $resp->get_StatusCode() . "\n";

$jResp = new CkJsonObject();
$jResp->Load($resp->bodyStr());
$jResp->put_EmitCompact(false);
print $jResp->emit() . "\n";

// The send succeeded if the response status code = 201.
if ($resp->get_StatusCode() != 200) {
    print 'Failed' . "\n";
    exit;
}

// Sample JSON response:

// {
//   "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('4ee732c3-322e-4a6b-b729-2fd1eb5c6004')/contacts/$entity",
//   "@odata.etag": "W/\"EQAAABYAAABUcG0qWqkmQYqWLHQataQxAAD0iYu5\"",
//   "id": "AAMkADYzZWE3YmZmLWU0YzgtNGNkZC04MGE1LWFiYTFlNTRlY2QwYQBGAAAAAAAu7cUXL5YOTrdsUIw7-v8FBwBUcG0qWqkmQYqWLHQataQxAAAAAAEOAABUcG0qWqkmQYqWLHQataQxAAD0sxexAAA=",
//   "createdDateTime": "2021-06-29T16:32:05Z",
//   "lastModifiedDateTime": "2021-06-29T16:57:39Z",
//   "changeKey": "EQAAABYAAABUcG0qWqkmQYqWLHQataQxAAD0iYu5",
//   "categories": [
//   ],
//   "parentFolderId": "AAMkADYzZWE3YmZmLWU0YzgtNGNkZC04MGE1LWFiYTFlNTRlY2QwYQAuAAAAAAAu7cUXL5YOTrdsUIw7-v8FAQBUcG0qWqkmQYqWLHQataQxAAAAAAEOAAA=",
//   "birthday": "1974-07-22T11:59:00Z",
//   "fileAs": "",
//   "displayName": "Pavel Bansky",
//   "givenName": "Pavel",
//   "initials": null,
//   "middleName": null,
//   "nickName": null,
//   "surname": "Bansky",
//   "title": null,
//   "yomiGivenName": null,
//   "yomiSurname": null,
//   "yomiCompanyName": null,
//   "generation": null,
//   "imAddresses": [
//   ],
//   "jobTitle": null,
//   "companyName": null,
//   "department": null,
//   "officeLocation": null,
//   "profession": null,
//   "businessHomePage": null,
//   "assistantName": null,
//   "manager": null,
//   "homePhones": [
//   ],
//   "mobilePhone": null,
//   "businessPhones": [
//     "+1 732 555 0102"
//   ],
//   "spouseName": null,
//   "personalNotes": "",
//   "children": [
//   ],
//   "emailAddresses": [
//     {
//       "name": "Pavel Bansky",
//       "address": "pavelb@fabrikam.onmicrosoft.com"
//     }
//   ],
//   "homeAddress": {
//     "street": "123 Some street",
//     "city": "Seattle",
//     "state": "WA",
//     "postalCode": "98121"
//   },
//   "businessAddress": {},
//   "otherAddress": {}
// }

print 'Contact updated.' . "\n";

?>