provisionProgram( )

Creates a program for the specified beneficiary. Creating a program is also referred to as provisioning a program.

You can provision a program from a program definition or a pool definition:

  • Program definition: The provisioned program has pools that are created from the pool definitions in the program definition.
  • Pool definition: The provisioned program has 1 pool that is created from the 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
poolDefinitionLookupIdPoolDefinitionLookupIdRequired

The program definition or pool definition to use to provision the program.

optionsProvisionProgramOptions
Returns
Return Type:Promise<ProvisionProgramResponse>
Errors
409Already Exists

There are 2 errors with this status code.

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

Did this help?