Partilhar via


Atualizar contato

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Atualize as propriedades do objeto de contacto.

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global US Government L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Uma das seguintes permissões é necessária para chamar esta API. Para saber mais, incluindo como escolher permissões, confira Permissões.

Tipo de permissão Permissões (da com menos para a com mais privilégios)
Delegado (conta corporativa ou de estudante) Contacts.ReadWrite
Delegado (conta pessoal da Microsoft) Contacts.ReadWrite
Aplicativo Contacts.ReadWrite

Solicitação HTTP

Um contacto do contacto predefinido do utilizadorPasta.

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

Um contact da contactFolder de nível superior do usuário.

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

Um contact incluso em uma pasta filha de uma contactFolder. O exemplo a seguir mostra um nível de aninhamento, mas um contato pode estar localizado em um filho de um filho e assim por diante.

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

Cabeçalhos de solicitação

Cabeçalho Valor
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça os valores para os campos relevantes que devem ser atualizados. Propriedades existentes que não estão incluídas no corpo da solicitação terão seus valores anteriores mantidos ou serão recalculadas com base nas alterações a outros valores de propriedade. Para obter o melhor desempenho, não inclua valores existentes que não foram alterados.

Propriedade Tipo Descrição
assistantName String O nome do assistente do contato.
birthday DateTimeOffset O aniversário do contato.
categories String As categorias associadas ao contato.
children Cadeia de caracteres
CompanyName String O nome da empresa do contato.
departamento String O departamento do contato.
displayName String O nome para exibição do contato. Observe que atualizações posteriores em outras propriedades podem fazer com que um valor gerado automaticamente sobrescreva o valor de displayName que você especificou. Para preservar a um valor preexistente, inclua-o como o displayName na operação atualizar.
emailAddresses coleção typedEmailAddress Os endereços de email do contato.
fileAs String O nome com o qual o contato está arquivado.
gender Cadeia de caracteres O sexo do contacto.
generation String A geração do contato.
givenName String O nome do contato.
imAddresses String Os endereços de mensagens instantâneas do contato.
initials String As iniciais do contato.
jobTitle String O cargo do contato.
manager String O nome do gerente do contato.
middleName String O nome do meio do contato.
nickName String O apelido do contato.
officeLocation String O local do escritório do contato.
parentFolderId String A ID da pasta pai do contato.
personalNotes String As anotações do usuário sobre o contato.
telefones Coleção phone Números de telefone associados ao contacto, por exemplo, telefone de casa, telemóvel e telefone da empresa.
postalAddresses coleção physicalAddress Endereços associados ao contacto, por exemplo, endereço de casa e endereço comercial.
primaryEmailAddress emailAddress A endereço de email principal do contacto. Opcional.
profession String A profissão do contato.
secondaryEmailAddress emailAddress O endereço de e-mail secundário do contacto. Opcional.
spouseName String O nome do cônjuge/parceiro do contato.
surname String O sobrenome do contato.
tertiaryEmailAddress emailAddress O endereço de e-mail terciário do contacto. Opcional.
title String O título do contato.
websites Coleção website Web sites associados ao contacto.
weddingAnniversary Data O aniversário de casamento do contacto.
yomiCompanyName String O nome de empresa japonês fonético do contato. Essa propriedade é opcional.
yomiGivenName String O nome japonês fonético do contato. Essa propriedade é opcional.
yomiSurname String O sobrenome japonês fonético (apelido) do contacto. Essa propriedade é opcional.

Uma vez que o recurso de contacto suporta extensões, pode utilizar a PATCH operação para adicionar, atualizar ou eliminar os seus próprios dados específicos da aplicação em propriedades personalizadas de uma extensão numa instância de contacto existente.

Resposta

Se for bem-sucedido, este método devolve um 200 OK código de resposta e um objeto de contacto atualizado no corpo da resposta.

Exemplo

Solicitação

O exemplo seguinte atualiza o endereço de e-mail pessoal do contacto especificado.

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"
        }
    ]
}

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

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"
        }
    ],
    "primaryEmailAddress": {
        "name": "Pavel Bansky",
        "address": "pavelb@contoso.com"
    },
    "secondaryEmailAddress": {
        "name": "Pavel Bansky",
        "address": "pavelb@contoso.com"
    },
    "tertiaryEmailAddress": null,
    "websites":[

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

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