contactFolder 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 folder that contains contacts.
This resource supports using delta query to track incremental additions, deletions, and updates, by providing a delta function.
Methods
| Method | Return Type | Description |
|---|---|---|
| Get | contactFolder | Get a contact folder by using the contact folder ID. |
| Update | contactFolder | Update contactFolder object. |
| Delete | None | Delete a contactFolder object. |
| Permanently delete | None | Permanently delete a contact folder and remove its items from the user's mailbox. |
| List child folders | contactFolder collection | Get a collection of child folders under the specified contact folder. |
| Create child folder | contactFolder | Create a new contactFolder as a child of a specified folder. |
| Get contact delta | contact collection | Get a set of contact folders that were 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 property | contactFolder | Create one or more single-value extended properties in a new or existing contactFolder. |
| Get single-value property | contactFolder | Get contactFolders that contain a single-value extended property by using $expand or $filter. |
| Create multi-value property | contactFolder | Create one or more multi-value extended properties in a new or existing contactFolder. |
| Get multi-value 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
The following JSON representation shows the resource type.
{
"displayName": "String",
"id": "String (identifier)",
"parentFolderId": "String",
"wellKnownName": "String"
}