contactFolder resource type

A folder that contains contacts.

Delta query support

This resource supports delta query to track incremental additions, deletions, and updates, by providing a delta function.

Methods

Method Return Type Description
Get contactFolder contactFolder Get a contact folder by using the contact folder ID.
Update contactFolder Update contactFolder object.
Delete None Delete contactFolder object.
List childFolders contactFolder collection Get a collection of child folders under the specified contact folder.
Create child contactFolder contactFolder Create a new contactFolder as a child of a specified folder.
delta contact collection Get a set of contact folders that have been added, deleted, or removed from the user's mailbox.
List contacts in folder contact collection Get a contact collection from the default Contacts folder of the signed-in user (.../me/contacts), or from the specified contact folder.
Create contact in folder contact Add a contact to the root Contacts folder or to the contacts endpoint of another contact folder.
Extended properties
Create single-value extended property contactFolder Create one or more single-value extended properties in a new or existing contactFolder.
Get contactFolder with single-value extended property contactFolder Get contactFolders that contain a single-value extended property by using $expand or $filter.
Create multi-value extended property contactFolder Create one or more multi-value extended properties in a new or existing contactFolder.
Get contactFolder with multi-value extended property contactFolder Get a contactFolder that contains a multi-value extended property by using $expand.

Properties

Property Type Description
displayName String The folder's display name.
id String Unique identifier of the contact folder. Read-only.
parentFolderId String The ID of the folder's parent folder.
wellKnownName string The name of the folder if the folder is a recognized folder. Currently contacts is the only recognized contacts folder.

Relationships

Relationship Type Description
childFolders ContactFolder collection The collection of child folders in the folder. Navigation property. Read-only. Nullable.
contacts Contact collection The contacts in the folder. Navigation property. Read-only. Nullable.
multiValueExtendedProperties multiValueLegacyExtendedProperty collection The collection of multi-value extended properties defined for the contactFolder. Read-only. Nullable.
singleValueExtendedProperties singleValueLegacyExtendedProperty collection The collection of single-value extended properties defined for the contactFolder. Read-only. Nullable.

JSON representation

Here is a JSON representation of the resource

{
  "displayName": "string",
  "id": "string (identifier)",
  "parentFolderId": "string",
  "wellKnownName": "string"
}