title	presence: setUserPreferredPresence
description	Set the user preferred presence for a user
author	awang119
ms.localizationpriority	medium
doc_type	apiPageType
ms.subservice	cloud-communications
ms.date	04/05/2024

presence: setUserPreferredPresence

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Set the preferred availability and activity status for a user. If the preferred presence of a user is set, the user's presence is the preferred presence.

Preferred presence takes effect only when there is at least one presence session of the user. Otherwise, the user's presence stays as Offline.

A presence session can be created as a result of a successful setPresence operation, or if the user is signed in on a Teams client.

Read more about presence sessions and their time-out and expiration.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

HTTP Request

POST /users/{id}/presence/setUserPreferredPresence

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type	application/json. Required.

Request body

In the request body, provide a JSON object with the following parameters.

Parameter	Type	Description
availability	string	The base presence information.
activity	string	The supplemental information to availability.
expirationDuration	duration	The expiration of the app presence session. The value is represented in ISO 8601 format for durations. If not provided, a default expiration will be applied: DoNotDisturb or Busy: expires in 1 day All others: expires in 7 days

Supported combinations of availability and activity are:

availability	activity	Description
Available	Available	Set the user preferred presence as Available.
Busy	Busy	Set the user preferred presence as Busy.
DoNotDisturb	DoNotDisturb	Set the user preferred presence as DoNotDisturb.
BeRightBack	BeRightBack	Set the user preferred presence as BeRightBack.
Away	Away	Set the user preferred presence as Away.
Offline	OffWork	Set the user preferred presence as Offline.

Response

If successful, this method returns a 200 OK response code.

Examples

The following request sets the user preferred presence as DoNotDisturb for user fa8bf3dc-eca7-46b7-bad1-db199b62afc3, with the expiration of 8 hours.

Request

HTTP

POST https://graph.microsoft.com/beta/users/fa8bf3dc-eca7-46b7-bad1-db199b62afc3/presence/setUserPreferredPresence
Content-Type: application/json

{
  "availability": "DoNotDisturb",
  "activity": "DoNotDisturb",
  "expirationDuration": "PT8H"
}