presence: setUserPreferredPresence

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.

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.

Permissions

The following permission is required to call the API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Presence.ReadWrite
Delegated (personal Microsoft account) Not Supported.
Application Presence.ReadWrite.All

HTTP Request

POST /users/{userId}/presence/setUserPreferredPresence

Request headers

Name Description
Authorization Bearer {token}. Required.
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

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

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

Response

HTTP/1.1 200 OK