contact resource type

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

A contact is an item in Outlook where you can organize and save information about the people and organizations you communicate with. Contacts are contained in contact folders.

This resource supports:

Methods

Method Return Type Description
Get contact Read properties and relationships of contact object.
Create contact Add a contact to the root Contacts folder or to the contacts endpoint of another contact folder.
Update contact Update contact object.
Delete None Delete contact object.
Permanently delete None Permanently delete a contact and place it in the Purges folder in the Recoverable Items folder in the user's mailbox.
Get contact delta contact collection Get a set of contacts that have been added, deleted, or updated in a specified folder.
Open extensions
Create open extension openTypeExtension Create an open extension and add custom properties to a new or existing resource.
Get open extension openTypeExtension collection Get an open extension identified by the extension name.
Extended properties
Create single-value property contact Create one or more single-value extended properties in a new or existing contact.
Get single-value property contact Get contacts that contain a single-value extended property by using $expand or $filter.
Create multi-value property contact Create one or more multi-value extended properties in a new or existing contact.
Get multi-value property contact Get a contact that contains a multi-value extended property by using $expand.

Properties

Property Type Description
assistantName String The name of the contact's assistant.
birthday DateTimeOffset The contact's birthday. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
categories String collection The categories associated with the contact. Each category corresponds to the displayName property of an outlookCategory defined for the user.
changeKey String Identifies the version of the contact. Every time the contact is changed, changeKey changes as well, which allows Exchange to apply changes to the correct version of the object.
children String collection The names of the contact's children.
companyName String The name of the contact's company.
createdDateTime DateTimeOffset The time the contact was created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
department String The contact's department.
displayName String The contact's display name. You can specify the display name in a create or update operation. Later updates to other properties might cause an automatically generated value to overwrite the displayName value you specified. To preserve a pre-existing value, always include it as displayName in an update operation.
emailAddresses typedEmailAddress collection The contact's email addresses.
fileAs String The name the contact is filed under.
flag followupFlag The flag value that indicates the status, start date, due date, or completion date for the contact.
gender String The contact's gender.
generation String The contact's suffix.
givenName String The contact's given name.
id String Unique identifier for the contact. By default, this value changes when the item is moved from one container (such as a folder or calendar) to another. To change this behavior, use the Prefer: IdType="ImmutableId" header. See Get immutable identifiers for Outlook resources for more information. Read-only.
imAddresses String collection The contact's instant messaging (IM) addresses.
initials String The contact's initials.
jobTitle String The contact’s job title.
lastModifiedDateTime DateTimeOffset The time the contact was modified. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
manager String The name of the contact's manager.
middleName String The contact's middle name.
nickName String The contact's nickname.
officeLocation String The location of the contact's office.
parentFolderId String The ID of the contact's parent folder.
personalNotes String The user's notes about the contact.
phones phone collection Phone numbers associated with the contact, for example, home phone, mobile phone, and business phone.
postalAddresses physicalAddress collection Addresses associated with the contact, for example, home address and business address.
profession String The contact's profession.
spouseName String The name of the contact's spouse/partner.
surname String The contact's surname.
title String The contact's title.
websites website collection Web sites associated with the contact.
weddingAnniversary Date The contact's wedding anniversary.
yomiCompanyName String The phonetic Japanese company name of the contact.
yomiGivenName String The phonetic Japanese given name (first name) of the contact.
yomiSurname String The phonetic Japanese surname (last name) of the contact.

Relationships

Relationship Type Description
extensions extension collection The collection of open extensions defined for the contact. Nullable.
multiValueExtendedProperties multiValueLegacyExtendedProperty collection The collection of multi-value extended properties defined for the contact. Read-only. Nullable.
photo photo Optional contact picture. You can get or set a photo for a contact.
singleValueExtendedProperties singleValueLegacyExtendedProperty collection The collection of single-value extended properties defined for the contact. Read-only. Nullable.

JSON representation

The following JSON representation shows the resource type.

{
  "assistantName": "string",
  "birthday": "String (timestamp)",
  "categories": ["string"],
  "changeKey": "string",
  "children": ["string"],
  "companyName": "string",
  "createdDateTime": "String (timestamp)",
  "department": "string",
  "displayName": "string",
  "emailAddresses": [{"@odata.type": "microsoft.graph.typedEmailAddress"}],
  "fileAs": "string",
  "flag": {"@odata.type": "microsoft.graph.followupFlag"},
  "gender": "string",
  "generation": "string",
  "givenName": "string",
  "id": "string (identifier)",
  "imAddresses": ["string"],
  "initials": "string",
  "jobTitle": "string",
  "lastModifiedDateTime": "String (timestamp)",
  "manager": "string",
  "middleName": "string",
  "nickName": "string",
  "officeLocation": "string",
  "parentFolderId": "string",
  "personalNotes": "string",
  "phones": [{"@odata.type": "microsoft.graph.phone"}],
  "postalAddresses": [{"@odata.type": "microsoft.graph.physicalAddress"}],
  "profession": "string",
  "spouseName": "string",
  "surname": "string",
  "title": "string",
  "websites": [{"@odata.type": "microsoft.graph.website"}],
  "weddingAnniversary": "date",
  "yomiCompanyName": "string",
  "yomiGivenName": "string",
  "yomiSurname": "string"
}