Set Other User's Presence - Admin

Sets the presence state of a another user.

🚧 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 1 year ago

Was this helpful?

Set presence information for a particular user.

post

/v3/user/presence

Query parameters

softboolean

If true, the user's current status is taken into consideration. If the user is currently OFFLINE, the user's presence will still be OFFLINE, but the new presence will take effect when the user comes online. If the user is currently online, the user's activity state will be applied to the presence if applicable. (e.g. if you are setting their presence to AVAILABLE, but the user is currently idle, their status will be represented as AWAY)

Header parameters

sessionTokenstringrequired

Session authentication token.

Body

categorystringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'yourpodURL.symphony.com/pod/v3/user/presence' \
  --header 'sessionToken: text' \
  --header 'Content-Type: application/json' \
  --data '{"category":"AWAY","userId":14568529068038}'

200

400

401

403

404

500

{
  "category": "AVAILABLE",
  "userId": 14568529068038,
  "timestamp": 1533928483800
}