deletePoolDefinition( )

Deletes a pool definition.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
SCOPE.BENEFIT_PROGRAMS.MANAGE
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
poolDefinitionIdstringRequired

ID of the pool definition to delete.

cascadeCascadeRequired

Required*. Determines when the changes to this pool definition the program definitions containing it will be applied to associated programs and pools.

Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?