Set Other User's Presence - Admin

Sets the presence state of a another user.

Set presence information for a particular user.

POSTyourpodURL.symphony.com/pod/v3/user/presence
Query parameters
Header parameters
Body
category*string

Presence status. Possible values are:

  • UNDEFINED
  • AVAILABLE
  • BUSY
  • DO_NOT_DISTURB
  • ON_THE_PHONE
  • BE_RIGHT_BACK
  • IN_A_MEETING
  • AWAY
  • OUT_OF_OFFICE
  • OFF_WORK
  • OFFLINE
Example: "AWAY"
userIdinteger (int64)

The ID of the user to whom the presence state relates.

Example: 14568529068038
Response

OK

Body
category*string

Presence status. Possible values are:

  • UNDEFINED
  • AVAILABLE
  • BUSY
  • DO_NOT_DISTURB
  • ON_THE_PHONE
  • BE_RIGHT_BACK
  • IN_A_MEETING
  • AWAY
  • OUT_OF_OFFICE
  • OFF_WORK
  • OFFLINE
Example: "AWAY"
userIdinteger (int64)

The ID of the user to whom the presence state relates.

Example: 14568529068038
timestampinteger (int64)

The time, in milliseconds since Jan 1 1970, when the presence state was set.

Example: 1533928483800
Request
const response = await fetch('yourpodURL.symphony.com/pod/v3/user/presence', {
    method: 'POST',
    headers: {
      "sessionToken": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "category": "AWAY"
    }),
});
const data = await response.json();
Response
{
  "category": "AWAY",
  "userId": 14568529068038,
  "timestamp": 1533928483800
}

🚧 User role requirement

To set the presence of another user, this endpoint requires to be called by a service user with the "User Provisioning" Entitlement.

Last updated