Symphony REST APIs
Search
⌃K

Set Other User's Presence - Admin

Sets the presence state of a another user.
post
https://yourpodURL.symphony.com/pod
/v3/user/presence
Set presence information for a particular user.
Parameters
Query
soft
string
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
sessionToken*
string
Session authentication token.
Body
presence*
string
Body
Example
Schema
{}
Responses
200: OK
OK
400: Bad Request
Client error, see response body for further details.
401: Unauthorized
Unauthorized: Invalid session token.
403: Forbidden
Forbidden: Caller lacks necessary entitlement.
404: Not Found
Not Found: user id cannot be located.
500: Internal Server Error
Server error, see response body for further details.

🚧 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 modified 2mo ago