# Clear a user's Will Return / Out of Roam

`POST /user.status.clear`

## Description

Remove the Will Return / Out of Roam previously written with
[`user.status.set`](/docs/api/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](/docs/guides/user-status) 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](https://developer.ro.am/chat-v1.json)

## Authentication

```
Authorization: Bearer YOUR_API_KEY
```

## Request Body

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `userId` | string | Yes | Target user. Bare UUID, tagged `U-…` ID, or ASCII email (same convention as `group.create` members). Personal tokens may only pass their own user.  |

### Example Request

```json
{
  "userId": "ada@example.com"
}
```

## Responses

### 204 - Absence cleared, or there was nothing to clear. No response body.


### 400 - Bad request. Common causes:
- Missing `userId`
- `userId` is not a UUID, tagged ID, or ASCII email


### 401 - Presented invalid authentication credentials.

### 403 - Forbidden. Common causes:
- Missing `user:write.status` (OAuth / API key)
- Personal token targeting a user other than the owner (`access_denied`)


### 404 - User not found, archived, or not in this workspace (`user_not_found`).


### 405 - An unsupported method was requested.

### 500 - An internal error occurred.

---

*Machine-readable API documentation.*
*Full documentation: https://developer.ro.am/docs/api/user-status-clear*