removePoolDefinitionFromProgramDefinition( )


Removes a pool definition from a program definition.

Pool definitions don't need to be contained by a program definition, so this doesn't affect the usability of this pool definition.

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
optionsRemovePoolDefinitionFromProgramDefinitionOptionsRequired

poolDefinitionIdstringRequired

ID of the pool definition to remove from the program definition.

Returns
Return Type:Promise<RemovePoolDefinitionFromProgramDefinitionResponse>
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?