---
editLink: false
lastUpdated: false
---

[@salesforce/b2c-tooling-sdk](../../modules.md) / [clients](../index.md) / purgeUser

# Function: purgeUser()

> **purgeUser**(`client`, `userId`): `Promise`\<`void`\>

Defined in: [packages/b2c-tooling-sdk/src/clients/am-api.ts:425](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/36eea0d308f1312d1a446ec8813ed30b0bdba62c/packages/b2c-tooling-sdk/src/clients/am-api.ts#L425)

Purges a user (hard delete).
Users must be in DELETED state before they can be purged.

## Parameters

### client

[`AccountManagerUsersClient`](../type-aliases/AccountManagerUsersClient.md)

Account Manager Users client

### userId

`string`

User ID

## Returns

`Promise`\<`void`\>

## Throws

Error if request fails