WorkStatus REST API endpoint
Disclaimer: This endpoint documentation is generated from the latest Sitevision version. It might differ from the actual Sitevision environment where your website resides.
Use the RestApi utility of the Public API for server-side access of this endpoint.
WorkStatus
Get, set and clear work status for a user identity.
Applicable to: sv:userIdentity.
GET
Returns an object describing current work status for a sv:userIdentity. Returns empty object if user identity has no current status.
Requires the feature "social collaboration" and that social collaboration is enabled on the sv:site.
Requires that the caller is authorized to READ on the sv:site.
Example URL
400.95b3be916257bc215c3ea/workstatus
Example response
{
"id": "752.77f59fca188fc1994b74",
"shortcodes": ":spiral_calendar_pad:",
"text": "In a meeting",
"expires": 1687852412632,
"pauseNotifications": true,
"durationType": "CUSTOM"
}
POST
Set a work status for a sv:userIdentity.
Requires the feature "social collaboration" and that social collaboration is enabled on the sv:site.
Requires that the caller is the targeted sv:userIdentity or is authorized to MANAGE_USER_IDENTITIES on the sv:site.
| Name | Type | Default | Values | Description |
|---|---|---|---|---|
| shortcodes | string |
An emoji shortcode (:+1::skin-tone-2:). | ||
| text | string |
The status text. Max 100 characters. | ||
| expires | number |
0 | UNIX timestamp for when the status expires. 0 indicates no expiration. | |
| pauseNotifications | boolean |
false | Whether or not notifications should be paused during the status lifetime. | |
| durationType | string |
CUSTOM | INDEFINITELY, THIRTY_MINUTES, ONE_HOUR, FOUR_HOURS, END_OF_TODAY, END_OF_WEEK, CUSTOM | Can be used to pre-select a duration when in a list of recent work statuses. |
Example URL
400.95b3be916257bc215c3ea/workstatus
Example input
{
"shortcodes": ":spiral_calendar_pad:",
"text": "In a meeting",
"expires": 1687852412632,
"pauseNotifications": true,
"durationType": CUSTOM,
}
Example response
{
"id": "752.77f59fca188fc1994b74",
"shortcodes": ":spiral_calendar_pad:",
"text": "In a meeting",
"expires": 1687852412632,
"pauseNotifications": true,
"durationType": "CUSTOM"
}
DELETE
Clear a work status for a sv:userIdentity.
Requires the feature "social collaboration" and that social collaboration is enabled on the sv:site.
Requires that the caller is the targeted sv:userIdentity or is authorized to MANAGE_USER_IDENTITIES on the sv:site.
Requires that the targeted sv:workStatus is the current work status of the targeted sv:userIdentity.
Example URL
400.95b3be916257bc215c3ea/workstatus/752.77f59fca188fc1994b74