Обновление контакта

Пространство имен: microsoft.graph

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Обновление свойств объекта contact.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба Правительство США L4 Правительство США L5 (DOD) Китай управляется 21Vianet

Разрешения

Для вызова этого API требуется одно из следующих разрешений. Дополнительные сведения, включая сведения о том, как выбрать разрешения, см. в статье Разрешения.

Тип разрешения Разрешения (в порядке повышения привилегий)
Делегированные (рабочая или учебная учетная запись) Contacts.ReadWrite
Делегированные (личная учетная запись Майкрософт) Contacts.ReadWrite
Для приложений Contacts.ReadWrite

HTTP-запрос

Контакт из объекта contactFolder пользователя по умолчанию.

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

Объект contact из пользовательской папки contactFolder верхнего уровня.

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

Объект contact из дочерней папки в папке contactFolder. Приведенный ниже пример показывает один уровень вложенности, но для хранения контакта допускается несколько.

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

Заголовки запросов

Заголовок Значение
Авторизация Bearer {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 Адреса контакта для обмена мгновенными сообщениями.
initials String Инициалы контакта.
jobTitle String Должность контакта.
manager String Имя руководителя контакта.
middleName String Отчество контакта.
nickName String Псевдоним контакта.
officeLocation String Расположение офиса контакта.
parentFolderId String Идентификатор родительской папки контакта.
personalNotes String Заметки пользователя о контакте.
phones Коллекция phone Номера телефонов, связанные с контактом, например домашний телефон, мобильный телефон и рабочий телефон.
postalAddresses коллекция physicalAddress Адреса, связанные с контактом, например домашний адрес и рабочий адрес.
profession String Профессия контакта.
spouseName String Имя супруга или супруги контакта.
surname String Фамилия контакта.
title String Звание контакта.
websites Коллекция website Веб-сайты, связанные с контактом.
weddingAnniversary Date Годовщина свадьбы контакта.
yomiCompanyName String Название компании контакта, записанное так, как оно звучит по-японски. Это необязательное свойство.
yomiGivenName String Имя контакта, записанное так, как оно звучит по-японски. Это необязательное свойство.
yomiSurname String Фонетическая японская фамилия (фамилия) контакта. Это необязательное свойство.

Так как ресурс contact поддерживает расширения, можно использовать 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"
    }
}