getPoolDefinition( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a pool definition.

Permissions
SCOPE.BENEFIT_PROGRAMS.MANAGE
SCOPE.BENEFIT_PROGRAMS.READ
Manage Events
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
poolDefinitionIdstringRequired

ID of the pool definition to retrieve.

Returns
Return Type:Promise<PoolDefinition>
Errors

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

Did this help?
OSZAR »