provisionProgram( )

Developer Preview

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

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
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
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?