updatePoolDefinition( )


Updates a pool definition.

Each time the pool definition is updated, revision increments by 1. The current revision must be passed when updating the pool definition. This ensures you're working with the latest pool definition and prevents unintended overwrites.

Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
SCOPE.BENEFIT_PROGRAMS.MANAGE
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
_idstringRequired

Pool definition ID.


poolDefinitionUpdatePoolDefinitionRequired

optionsUpdatePoolDefinitionOptions
Returns
Return Type:Promise<PoolDefinition>
Errors
400Invalid Argument

There are 2 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?