deactivateProfile - Cognigy Documentation

Syntax

deactivateProfile(deleteData)

Description

Deactivates the user’s Contact Profile. While the Contact Profile is deactivated, no data can be read from or written to the Contact Profile. This function can be used to temporarily disable a Contact Profile or to permanently remove data if required.

Parameters:

• deleteData: boolean — if set to true, existing data will be erased from the Contact Profile.

Returns: Promise<any>

Example

// Temporarily deactivate the Contact Profile without deleting any data
await deactivateProfile(false);

// Deactivate the Contact Profile and permanently delete all associated data
await deactivateProfile(true);

Last modified on April 21, 2026