findPoolDefinitionsByProgramDefinition( )

Developer Preview

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

Retrieve all a program definition's pool definitions.

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

ID of the program definition to retrieve its pool definitions.

optionsFindPoolDefinitionsByProgramDefinitionOptionsRequired
Returns
Return Type:Promise<FindPoolDefinitionsByProgramDefinitionResponse>
Errors

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

Did this help?