連絡先を更新するUpdate contact

重要

Microsoft Graph の/betaバージョンの api は変更される可能性があります。APIs under the /beta version in Microsoft Graph are subject to change. 実稼働アプリケーションでは、これらの API の使用はサポートされていません。Use of these APIs in production applications is not supported.

連絡先オブジェクトのプロパティを更新します。Update the properties of contact object.

アクセス許可Permissions

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

アクセス許可の種類Permission type アクセス許可 (特権の小さいものから大きいものへ)Permissions (from least to most privileged)
委任 (職場または学校のアカウント)Delegated (work or school account) Contacts.ReadWriteContacts.ReadWrite
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) Contacts.ReadWriteContacts.ReadWrite
アプリケーションApplication Contacts.ReadWriteContacts.ReadWrite

HTTP 要求HTTP request

ユーザーの既定のContactfolderからの連絡先A contact from user's default contactFolder.

PATCH /me/contacts/{id}
PATCH /users/{id | userPrincipalName}/contacts/{id}

ユーザーの最上位レベル contactFolder からの 連絡先A contact from a user's top level contactFolder.

PATCH /me/contactFolders/{id}/contacts/{id}
PATCH /users/{id | userPrincipalName}/contactFolders/{id}/contacts/{id}

contactFolder の子フォルダー内に含まれる 連絡先A contact contained in a child folder of a contactFolder. 次の例は、入れ子のレベルの 1 つを示していますが、連絡先は子の子などに入れることができます。The example below shows one level of nesting, but a contact can be located in a child of a child and so on.

PATCH /me/contactFolder/{id}/childFolders/{id}/.../contacts/{id}
PATCH /users/{id | userPrincipalName}/contactFolders/{id}/childFolders/{id}/contacts/{id}

要求ヘッダーRequest headers

ヘッダーHeader Value
AuthorizationAuthorization ベアラー {トークン}。必須。Bearer {token}. Required.
Content-TypeContent-Type application/json. Required.application/json. Required.

要求本文Request body

要求本文で、更新する関連フィールドの値を指定します。要求本文に含まれない既存のプロパティは、以前の値のままになるか、他のプロパティ値の変化に基づいて再計算されます。最適なパフォーマンスを得るためには、変更されていない既存の値を含めないでください。In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.

プロパティProperty Type 説明Description
assistantNameassistantName StringString 連絡先のアシスタントの名前。The name of the contact's assistant.
birthdaybirthday DateTimeOffsetDateTimeOffset 連絡先の誕生日です。The contact's birthday.
categoriescategories StringString 連絡先に関連付けられたカテゴリ。The categories associated with the contact.
childrenchildren StringString
companyNamecompanyName StringString 連絡先の会社の名前。The name of the contact's company.
departmentdepartment StringString 連絡先の部署。The contact's department.
displayNamedisplayName 文字列String 連絡先の表示名。The contact's display name. 後で他のプロパティを更新すると、指定した displayName 値が自動的に生成された値に上書きされますので、ご注意ください。Note that later updates to other properties may cause an automatically generated value to overwrite the displayName value you have specified. 既存の値を保持するには、[更新] 操作で必ずその値を displayName として含めてください。To preserve a pre-existing value, always include it as displayName in an update operation.
emailAddressesemailAddresses typedEmailAddressコレクションtypedEmailAddress collection 連絡先のメール アドレス。The contact's email addresses.
fileAsfileAs StringString 連絡先がファイルされる名前。The name the contact is filed under.
gendergender StringString 連絡先の性別。The contact's gender.
generationgeneration StringString 連絡先の世代。The contact's generation.
givenNamegivenName StringString 連絡先の名。The contact's given name.
imAddressesimAddresses StringString 連絡先のインスタント メッセージング (IM) アドレス。The contact's instant messaging (IM) addresses.
initialsinitials StringString 連絡先のイニシャル。The contact's initials.
jobTitlejobTitle StringString 連絡先の役職。The contact’s job title.
managermanager StringString 連絡先の上司の名前。The name of the contact's manager.
middleNamemiddleName StringString 連絡先のミドル ネーム。The contact's middle name.
nickNamenickName StringString 連絡先のニックネーム。The contact's nickname.
officeLocationofficeLocation StringString 連絡先のオフィスの所在地。The location of the contact's office.
parentFolderIdparentFolderId StringString 連絡先の親フォルダーの ID。The ID of the contact's parent folder.
personalNotespersonalNotes StringString 連絡先に関するユーザーのメモ。The user's notes about the contact.
phonesphones phone コレクションphone collection 自宅電話、携帯電話、勤務先電話など、連絡先に関連付けられた電話番号。Phone numbers associated with the contact, for example, home phone, mobile phone, and business phone.
postalAddressespostalAddresses physicalAddressコレクションphysicalAddress collection 自宅住所や勤務先住所など、連絡先に関連付けられた住所。Addresses associated with the contact, for example, home address and business address.
professionprofession StringString 連絡先の専門的職業。The contact's profession.
spouseNamespouseName StringString 連絡先の配偶者/パートナーの名前。The name of the contact's spouse/partner.
surname 文字列String 連絡先の姓。The contact's surname.
titletitle StringString 連絡先の肩書。The contact's title.
websiteswebsites website コレクションwebsite collection 連絡先に関連付けられた Web サイト。Web sites associated with the contact.
weddingAnniversary 日weddingAnniversary 日付Date 連絡先の結婚記念日。The contact's wedding anniversary.
yomiCompanyNameyomiCompanyName StringString 連絡先の会社名の読み仮名。このプロパティは省略可能です。The phonetic Japanese company name of the contact. This property is optional.
yomiGivenNameyomiGivenName 文字列String 連絡先の名 (ファースト ネーム) の読み仮名。このプロパティは省略可能です。The phonetic Japanese given name (first name) of the contact. This property is optional.
yomiSurnameyomiSurname StringString 連絡先の姓 (ラスト ネーム) の読み仮名。このプロパティは省略可能です。The phonetic Japanese surname (last name) of the contact. This property is optional.

Contactリソースは拡張機能をサポートしているためPATCH 、操作を使用して、既存の連絡先インスタンスの拡張機能のカスタムプロパティで、独自のアプリ固有のデータを追加、更新、または削除することができます。Since the contact resource supports extensions, you can use the PATCH operation to add, update, or delete your own app-specific data in custom properties of an extension in an existing contact instance.

応答Response

成功した場合、このメソッド200 OKは応答コードと、応答本文で、更新された連絡先オブジェクトを返します。If successful, this method returns a 200 OK response code and updated contact object in the response body.

Example

要求Request

次の使用例は、指定された連絡先の個人用電子メールアドレスを更新します。The following example updates the personal email address of the specified contact.

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

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

以下は、応答の例です。注:簡潔にするために、ここに示す応答オブジェクトは切り詰められている場合があります。すべてのプロパティは実際の呼び出しから返されます。Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

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@adatum.onmicrosoft.com"
        },
        {
            "type":"other",
            "otherLabel":"Volunteer work",
            "name":"Pavel Bansky",
            "address":"pavelb@fabrikam.onmicrosoft.com"
        }
    ],
    "websites":[

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

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

SDK サンプルコードSDK sample code


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var emailAddresses = new TypedEmailAddress
{
    Address = "pavelb@fabrikam.onmicrosoft.com",
    Name = "Pavel Bansky",
    Type = EmailType.Other,
    OtherLabel = "Volunteer work",
};

var _emailAddresses = new TypedEmailAddress
{
    Type = EmailType.Personal,
    Name = "Pavel Bansky",
    Address = "pavelb@adatum.onmicrosoft.com",
};

var emailAddressesList = new List<TypedEmailAddress>();
emailAddressesList.Add( _emailAddresses );
emailAddressesList.Add( emailAddresses );

var contact = new Contact
{
    EmailAddresses = emailAddressesList,
};

await graphClient.Me.Contacts["AAMkADh6v5AAAvgTCEAAA="]
    .Request()
    .UpdateAsync(contact);

SDK をプロジェクトに追加し、 authproviderインスタンスを作成する方法の詳細については、 sdk のドキュメントを参照してください。Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.

関連項目See also