presence: setPresence

Namespace: microsoft.graph


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 availability and activity status in a presence session of an application for a user.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

Presence sessions

A user can have multiple presence sessions because the user can be on multiple Teams clients (desktop, mobile, and web). Each Teams client has an independent presence session and the user's presence is an aggregated state from all the sessions behind.

Similarly, an application can have its own presence session for a user and be able to update the state.

The following is the precedence for how session states are aggregated, with "A > B" representing A having precedence over B:

  • User-preferred state > session-level states (user-preferred state overrides session-level states)
  • Among session-level states: DoNotDisturb > Busy > Available > Away

Note: When a user presence changes in Microsoft Graph, because the Teams client uses poll mode, it will take a few minutes to update the presence status.

Timeout, expiration, and keep alive

A presence session may time out and expire, so the application needs to call this API before the timeout, to maintain the state for the session; or before the expiration, to keep the session alive.

A presence session can time out if the availability is Available and the timeout is 5 minutes. When it times out, the presence state fades in stages. For example, if an application sets the presence session as Available/Available, the state would change to Available/AvailableInactive in 5 minutes with the first timeout, then Away/Away in another 5 minutes with the second timeout.

The expiration of a presence session is configurable with the expirationDuration parameter. When a session expires it becomes Offline.


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.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) Presence.ReadWrite Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application Presence.ReadWrite.All Not available.

HTTP Request

POST /users/{userId}/presence/setPresence

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
sessionId string The ID of the application's presence session.
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 of 5 minutes will be applied.


Provide the ID of the application as sessionId in the request.

Supported combinations of availability and activity are:

availability activity Description
Available Available Updates the presence session as Available.
Busy InACall Updates the presence session as Busy, InACall.
Busy InAConferenceCall Updates the presence session as Busy, InAConferenceCall.
Away Away Updates the presence session as Away.
DoNotDisturb Presenting Updates the presence session as DoNotDisturb, Presenting.


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


The following request shows the application with ID 22553876-f5ab-4529-bffb-cfe50aa89f87 that sets its presence session for user fa8bf3dc-eca7-46b7-bad1-db199b62afc3.


Content-Type: application/json

  "sessionId": "22553876-f5ab-4529-bffb-cfe50aa89f87",
  "availability": "Available",
  "activity": "Available",
  "expirationDuration": "PT1H"


HTTP/1.1 200 OK