Delete attributes

wf.deleteAttributes(scope, names)

Delete specified custom attributes for the current user or page view. This method removes previously set attributes from storage. If you attempt to delete an attribute that doesn’t exist, the operation will be ignored and no error will be thrown.

Syntax

1wf.deleteAttributes(scope: 'user' | 'pageview', names: string[])

Parameters

  • scope: 'user' | 'pageview' - The scope of the attributes. You can choose to set attributes for the current user or the current page view.
  • names: string[] - An array of attribute names to delete.

Example implementation

1// Call the wf.ready() function the Browser API is available
2wf.ready(function() {
3  // Set attributes for the current user
4  wf.deleteAttributes('user', ['userSegment'])
5})

Returns

This method doesn’t return a value. It only deletes the specified attributes from storage. To see updated attributes, use wf.getAttributes().

Built with