alias.wipe
Wipes the data on an alias within a dimension, keeping the alias itself.
js
alias.wipe(dimensionName, aliasName)Parameters
| Parameter | Type | Description |
|---|---|---|
dimensionName | string | The dimension's name. |
aliasName | string | The alias's name. |
Returns
stringAn empty string when it succeeds, or an error message when it fails, such as when the dimension can't be found.
Examples
js
alias.wipe("Account", "No - Name");Related
- alias.createOrWipe: creates an alias within a dimension if it doesn't exist, or wipes the data on the alias if it already exists.
- alias.delete: deletes an alias from within a dimension permanently.