次の方法で共有

連絡先を更新する

  • [アーティクル]

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

連絡先オブジェクトのプロパティを更新します。

この 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. 必須です。

要求本文

要求本文で、更新する関連フィールドの値を指定します。 要求本文に含まれない既存のプロパティは、以前の値のままになるか、他のプロパティ値の変化に基づいて再計算されます。 最適なパフォーマンスを得るためには、変更されていない既存の値を含めないでください。

プロパティ 型 説明
assistantName String 連絡先のアシスタントの名前。
birthday DateTimeOffset 連絡先の誕生日です。
categories String 連絡先に関連付けられたカテゴリ。
children String
CompanyName String 連絡先の会社の名前。
department String 連絡先の部署。
displayName String 連絡先の表示名。 後で他のプロパティを更新すると、指定した displayName 値が自動的に生成された値に上書きされますので、ご注意ください。 既存の値を保持するには、[更新] 操作で必ずその値を displayName として含めてください。
emailAddresses typedEmailAddress コレクション 連絡先のメール アドレス。
fileAs String 連絡先がファイルされる名前。
gender String 連絡先の性別。
generation String 連絡先の世代。
givenName String 連絡先の名。
imAddresses String 連絡先のインスタント メッセージング (IM) アドレス。
initials String 連絡先のイニシャル。
jobTitle String 連絡先の役職。
manager String 連絡先の上司の名前。
middleName String 連絡先のミドル ネーム。
nickName String 連絡先のニックネーム。
officeLocation String 連絡先のオフィスの所在地。
parentFolderId String 連絡先の親フォルダーの ID。
personalNotes String 連絡先に関するユーザーのメモ。
phones phone コレクション 自宅電話、携帯電話、勤務先電話など、連絡先に関連付けられた電話番号。
postalAddresses physicalAddress コレクション 自宅住所や勤務先住所など、連絡先に関連付けられた住所。
profession String 連絡先の専門的職業。
spouseName String 連絡先の配偶者/パートナーの名前。
姓 String 連絡先の姓。
title String 連絡先の肩書。
websites website コレクション 連絡先に関連付けられた Web サイト。
weddingAnniversary Date 連絡先の結婚記念日。
yomiCompanyName String 連絡先の会社名の読み仮名。 このプロパティは省略可能です。
yomiGivenName String 連絡先の名 (ファースト ネーム) の読み仮名。 このプロパティは省略可能です。
yomiSurname String 連絡先の発音の日本語の姓 (姓)。 このプロパティは省略可能です。

連絡先リソースは拡張機能をサポートしているため、操作を使用して、既存のPATCH連絡先インスタンスの拡張機能のカスタム プロパティで独自のアプリ固有のデータを追加、更新、または削除できます。

応答

成功した場合、このメソッドは応答コードを 200 OK 返し、応答本文で 連絡先 オブジェクトを更新します。

例

要求

次の例では、指定した連絡先の個人用メール アドレスを更新します。

PATCH https://graph.microsoft.com/beta/me/contacts/AAMkADh6v5AAAvgTCEAAA=
Content-type: application/json

{
    "emailAddresses":[
        {
            "type":"personal",
            "name":"Pavel Bansky",
            "address":"pavelb@contoso.com"
        },
        {
          "address": "pavelb@contoso.com",
          "name": "Pavel Bansky",
          "type": "other",
          "otherLabel": "Volunteer work"
        }
    ]
}
応答

次の例は応答を示しています。 注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context":"https://graph.microsoft.com/beta/$metadata#users('c3e1fcd2-db78-42a8-aec5-1f2cd59abb5c')/contacts/$entity",
    "@odata.etag":"W/\"EQAAABYAAACv7At+UNVFRLhGciJGF6v5AAAve7fh\"",
    "id":"AAMkADh6v5AAAvgTCEAAA=",
    "createdDateTime":"2018-06-11T19:56:07Z",
    "lastModifiedDateTime":"2018-06-11T20:26:23Z",
    "changeKey":"EQAAABYAAACv7At+UNVFRLhGciJGF6v5AAAve7fh",
    "categories":[

    ],
    "parentFolderId":"AAMkADh6v5AAAAAAEOAAA=",
    "birthday":null,
    "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,
    "assistantName":null,
    "manager":null,
    "spouseName":null,
    "personalNotes":"",
    "children":[

    ],
    "gender":null,
    "isFavorite":null,
    "emailAddresses":[
        {
            "type":"personal",
            "name":"Pavel Bansky",
            "address":"pavelb@contoso.com"
        },
        {
            "type":"other",
            "otherLabel":"Volunteer work",
            "name":"Pavel Bansky",
            "address":"pavelb@contoso.com"
        }
    ],
    "websites":[

    ],
    "phones":[
        {
            "type":"business",
            "number":"+1 732 555 0102"
        }
    ],
    "postalAddresses":[

    ],
    "flag":{
        "flagStatus":"notFlagged"
    }
}

関連コンテンツ