---
name: "removeUser"
mode: "api"
versionRequirements:
  - { name: "@ray-js/lock-sdk", version: "1.0.0" }
title: "removeUser - Remove a regular member."
summary: "Remove a regular member. If the lock uses a small capacity solution, it is not recommended to use this API."
---

## removeUser

> [VERSION] @ray-js/lock-sdk >= 1.0.0

> 💡 If the lock uses a low-capacity solution, this API cannot be used; otherwise an error will be thrown. This API only supports deleting non-home system members.

### Description

Delete a regular user

### Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `userId` | `string` | Yes | User ID |

### Return Value

Type: `Promise<void>`

None

### Error Codes

| Error Code | Error Message |
| --- | --- |
| `1060` | Deleting regular members is not supported |
| `1072` | Deleting home members is not supported |

### Examples

#### Example

```ts
import { removeUser } from '@ray-js/lock-sdk';
await removeUser('user_001');
```