Clear a user's Will Return / Out of Roam
POST/user.status.clear
Remove the Will Return / Out of Roam previously written with
user.status.set or the desktop client.
Clears both same-day Will Return Today and persistent Out of Roam.
Clearing when nothing is set still returns 204. This call does not change check-in status.
See Will Return / Out of Roam for persistence, check-in interaction, and the HRIS lifecycle.
Access: Organization and Personal. Organization tokens may target any active member in the workspace. Personal tokens (OAuth or PAT) may target only the token owner.
Required scope: user:write.status. Personal Access Tokens skip
this check; personal-mode OAuth installs must still request the scope.
OpenAPI Spec: chat-v1.json
Request
Responses
- 204
- 400
- 401
- 403
- 404
- 405
- 500
Absence cleared, or there was nothing to clear. No response body.
Bad request. Common causes:
- Missing
userId userIdis not a UUID, tagged ID, or ASCII email
Presented invalid authentication credentials.
Forbidden. Common causes:
- Missing
user:write.status(OAuth / API key) - Personal token targeting a user other than the owner (
access_denied)
User not found, archived, or not in this workspace (user_not_found).
An unsupported method was requested.
An internal error occurred.