---
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:421](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d9cf11cf4a11828e783aed6313f5ea49990488ff/packages/b2c-tooling-sdk/src/clients/am-api.ts#L421)

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