presence: clearPresence

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.

Clear the application's presence session for a user. If it is the user's only presence session, the user's presence will change to Offline/Offline.

For details about presences sessions, see presence: setPresence.

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) Not Supported.
Delegated (personal Microsoft account) Not Supported.
Application Presence.ReadWrite.All

HTTP Request

POST /users/{userId}/presence/clearPresence

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

Important

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

Response

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

If the presence session doesn't exist, this method returns a 404 NotFound response code.

Examples

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

Request

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

{
  "sessionId": "22553876-f5ab-4529-bffb-cfe50aa89f87"
}

Response

HTTP/1.1 200 OK