連絡先を更新する
名前空間: microsoft.graph
連絡先オブジェクトのプロパティを更新します。
この API は、次の国内クラウド展開で使用できます。
グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
アクセス許可
この API を呼び出すには、次のいずれかのアクセス許可が必要です。 アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。
アクセス許可の種類 | アクセス許可 (特権の小さいものから大きいものへ) |
---|---|
委任 (職場または学校のアカウント) | Contacts.ReadWrite |
委任 (個人用 Microsoft アカウント) | Contacts.ReadWrite |
アプリケーション | Contacts.ReadWrite |
HTTP 要求
ユーザーの既定 contactFolder からの 連絡先。
PATCH /me/contacts/{id}
PATCH /users/{id | userPrincipalName}/contacts/{id}
ユーザーの最上位レベル contactFolder からの 連絡先。
PATCH /me/contactFolders/{id}/contacts/{id}
PATCH /users/{id | userPrincipalName}/contactFolders/{id}/contacts/{id}
contactFolder の子フォルダー内に含まれる 連絡先。 次の例は、入れ子のレベルの 1 つを示していますが、連絡先は子の子などに入れることができます。
PATCH /me/contactFolders/{id}/childFolders/{id}/.../contacts/{id}
PATCH /users/{id | userPrincipalName}/contactFolders/{id}/childFolders/{id}/contacts/{id}
要求ヘッダー
ヘッダー | 値 |
---|---|
Authorization | ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。 |
Content-Type | application/json. 必須です。 |
要求本文
要求本文で、更新する関連フィールドの値を指定します。 要求本文に含まれていない既存のプロパティは、以前の値を維持するか、他のプロパティ値の変更に基づいて再計算されます。 最適なパフォーマンスを得るために、変更されていない既存の値を含めないでください。
homeAddress などの構造化プロパティを更新する場合は、完全なプロパティ セットを渡す必要があります。
プロパティ | 種類 | 説明 |
---|---|---|
assistantName | String | 連絡先のアシスタントの名前。 |
birthday | DateTimeOffset | 連絡先の誕生日です。 |
businessAddress | PhysicalAddress | 連絡先の勤務先の住所。 |
businessHomePage | String | 連絡先の勤務先のホーム ページ。 |
businessPhones | String | 連絡先の勤務先の電話番号。 |
categories | String | 連絡先に関連付けられたカテゴリ。 |
children | String | 連絡先の子供の名前。 |
CompanyName | String | 連絡先の会社の名前。 |
department | String | 連絡先の部署。 |
displayName | String | 連絡先の表示名。 後で他のプロパティを更新すると、指定した displayName 値が自動的に生成された値に上書きされますので、ご注意ください。 既存の値を保持するには、[更新] 操作で必ずその値を displayName として含めてください。 |
emailAddresses | EmailAddress collection | 連絡先のメール アドレス。 |
fileAs | String | 連絡先がファイルされる名前。 |
generation | String | 連絡先の世代。 |
givenName | String | 連絡先の名。 |
homeAddress | PhysicalAddress | 連絡先の自宅住所。 |
homePhones | String collection | 連絡先の自宅の電話番号。 |
imAddresses | String | 連絡先のインスタント メッセージング (IM) アドレス。 |
initials | String | 連絡先のイニシャル。 |
jobTitle | String | 連絡先の役職。 |
manager | String | 連絡先の上司の名前。 |
middleName | String | 連絡先のミドル ネーム。 |
mobilePhone | String | 連絡先の携帯電話番号。 |
nickName | String | 連絡先のニックネーム。 |
officeLocation | String | 連絡先のオフィスの所在地。 |
otherAddress | PhysicalAddress | 連絡先の別の住所。 |
parentFolderId | String | 連絡先の親フォルダーの ID。 |
personalNotes | String | 連絡先に関するユーザーのメモ。 |
profession | String | 連絡先の専門的職業。 |
spouseName | String | 連絡先の配偶者/パートナーの名前。 |
姓 | String | 連絡先の姓。 |
title | String | 連絡先の肩書。 |
yomiCompanyName | String | 連絡先の会社名の読み仮名。 このプロパティは省略可能です。 |
yomiGivenName | String | 連絡先の名 (ファースト ネーム) の読み仮名。 このプロパティは省略可能です。 |
yomiSurname | String | 連絡先の発音の日本語の姓 (姓)。 このプロパティは省略可能です。 |
応答
成功した場合、このメソッドは 200 OK
応答コードと、応答本文で、更新された連絡先オブジェクトを返します。
例
要求
次の例は要求を示しています。
PATCH https://graph.microsoft.com/v1.0/me/contacts/{id}
Content-type: application/json
{
"homeAddress": {
"street": "123 Some street",
"city": "Seattle",
"state": "WA",
"postalCode": "98121"
},
"birthday": "1974-07-22"
}
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-type: application/json
{
"id": "AAMkAGI2THk0AAA=",
"createdDateTime": "2014-10-19T23:08:24Z",
"lastModifiedDateTime": "2014-10-19T23:08:24Z",
"changeKey": "EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa4",
"categories": [],
"parentFolderId": "AAMkAGI2AAEOAAA=",
"birthday": "1974-07-22",
"fileAs": "Fort, Garth",
"displayName": "Garth Fort",
"givenName": "Garth",
"initials": "G.F.",
"middleName": null,
"nickName": "Garth",
"surname": "Fort",
"title": null,
"yomiGivenName": null,
"yomiSurname": null,
"yomiCompanyName": null,
"generation": null,
"emailAddresses": [
{
"name": "Garth",
"address": "garth@contoso.com"
}
],
"imAddresses": [
"sip:garthf@contoso.com"
],
"jobTitle": "Web Marketing Manager",
"companyName": "Contoso, Inc.",
"department": "Sales & Marketing",
"officeLocation": "20/1101",
"profession": null,
"businessHomePage": "https://www.contoso.com",
"assistantName": null,
"manager": null,
"homePhones": [],
"mobilePhone": null,
"businessPhones": [
"+1 918 555 0101"
],
"homeAddress": {
"street": "123 Some street",
"city": "Seattle",
"state": "WA",
"postalCode": "98121"
},
"businessAddress": {
"street": "10 Contoso Way",
"city": "Redmond",
"state": "WA",
"countryOrRegion": "USA",
"postalCode": "98075"
},
"otherAddress": {},
"spouseName": null,
"personalNotes": null,
"children": []
}