Partilhar via


Atualizar contato

Namespace: microsoft.graph

Atualize as propriedades de um objeto contact.

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 contact da contactFolder padrão do usuário.

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. As propriedades existentes que não estão incluídas no corpo do pedido mantêm os valores anteriores ou são recalculadas com base em alterações a outros valores de propriedade. Para alcançar o melhor desempenho, não inclua valores existentes que não foram alterados.

Quando atualiza propriedades estruturadas, como homeAddress, tem de passar o conjunto de propriedades completo.

Propriedade Tipo Descrição
assistantName String O nome do assistente do contato.
birthday DateTimeOffset O aniversário do contato.
businessAddress PhysicalAddress O endereço comercial do contato.
businessHomePage String A home page comercial do contato.
businessPhones String Os números de telefone comerciais do contato.
categories String As categorias associadas ao contato.
children String Os nomes dos filhos do contato.
nomeDaEmpresa 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 EmailAddress Os endereços de email do contato.
fileAs String O nome com o qual o contato está arquivado.
generation String A geração do contato.
givenName String O nome do contato.
homeAddress PhysicalAddress O endereço residencial do contato.
homePhones Coleção de cadeias de caracteres Os números de telefone residenciais 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.
mobilePhone String O número de celular do contato.
nickName String O apelido do contato.
officeLocation String O local do escritório do contato.
otherAddress PhysicalAddress Outros endereços do contato.
parentFolderId String A ID da pasta pai do contato.
personalNotes String As anotações do usuário sobre o contato.
profession String A profissão do contato.
spouseName String O nome do cônjuge/parceiro do contato.
surname String O sobrenome do contato.
title String O título do contato.
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.

Resposta

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

Exemplos

Solicitação

O exemplo a seguir mostra uma solicitação.

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

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

{
  "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": []
}