> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # ProvisionProgram # Package: benefitPrograms # Namespace: ProgramService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/benefit-programs/programs/provision-program.md ## Permission Scopes: Manage benefit programs: SCOPE.BENEFIT_PROGRAMS.MANAGE ## Introduction 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. --- ## REST API ### Schema ``` Method: provisionProgram Description: 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. URL: https://www.wixapis.com/benefit-programs/v1/programs/provision Method: POST # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: externalProgramId, namespace Method parameters: param name: beneficiary | type: IdentificationData | required: true - ONE-OF: - required: true - name: anonymousVisitorId | type: string | description: GUID of a site visitor that hasn't logged in to the site. - name: memberId | type: string | description: GUID of a site member. - name: wixUserId | type: string | description: GUID of a Wix user. param name: displayName | type: displayName | description: Program name. If you're provisioning the program from a program definition, you may want to use the same name that was used for the program definition. param name: externalProgramId | type: externalProgramId | description: GUID for the program defined by you. You can use `externalId` to filter queries. | required: true param name: namespace | type: namespace | description: Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created. | required: true param name: poolDefinitionLookupId | type: PoolDefinitionLookupId | required: true - ONE-OF: - required: true - name: poolDefinitionId | type: string | description: Pool definition GUID. - name: programDefinitionId | type: string | description: Program definition GUID. param name: programStatus | type: ProgramStatus - enum: ACTIVE - Program is active. PAUSED - Program is paused. Return type: ProvisionProgramResponse - name: jobId | type: string | description: Job GUID of the provisioning of the program. Retrieve job details using the [Async Job API](https://dev.wix.com/docs/rest/business-management/async-job/introduction.md). - name: program | type: Program | description: Provisioned program. - name: id | type: string | description: Program GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the program is updated. To prevent conflicting changes, the current revision must be specified when updating the program. Ignored when creating a program. - name: createdDate | type: string | description: Date and time the program was created. - name: updatedDate | type: string | description: Date and time the program was updated. - name: programDefinitionId | type: string | description: GUID of the associated program definition. - name: status | type: ProgramStatus | description: Program status. - enum: - ACTIVE: Program is active. - PAUSED: Program is paused. It can be resumed. - ENDED: Program has ended. It can't be resumed. - PROVISIONING: Program is being activated for the first time. This status exists for a short time during processing. - PAUSING: Program is being paused. This status exists for a short time during processing. - RESUMING: Program is being re-activated after being paused. This status exists for a short time during processing. - ENDING: Program is being ended. This status exists for a short time during processing. - name: beneficiary | type: IdentificationData | description: Program beneficiary. - ONE-OF: - name: anonymousVisitorId | type: string | description: GUID of a site visitor that hasn't logged in to the site. - name: memberId | type: string | description: GUID of a site member. - name: wixUserId | type: string | description: GUID of a Wix user. - name: displayName | type: string | description: Program name. You may want to use the same name that's used in the associated program definition, if it exists. - name: namespace | type: string | description: Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created. - name: extendedFields | type: ExtendedFields | description: Custom field data for the program object. [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: externalId | type: string | description: GUID for the program defined by you. You can use `externalId` to filter queries. - name: programDefinition | type: ProgramDefinitionInfo | description: Associated program definition information. - name: id | type: string | description: Program definition GUID. - name: externalId | type: string | description: Program definition external GUID. Possible Errors: HTTP Code: 409 | Status Code: ALREADY_EXISTS | Application Code: IN_PROGRESS | Description: Program creation is in progress. HTTP Code: 409 | Status Code: ALREADY_EXISTS | Application Code: PROGRAM_ALREADY_EXISTS | Description: Program already exists with pools. ``` ### Examples ### ProvisionProgram ```curl ~~~cURL curl --request POST https://www.wixapis.com/benefit-programs/v1/programs/provision \ -H "Authorization: " \ -H "Content-Type: application/json" \ --data '{ "pool_definition_reference": { "program_definition_id": "e8c3366e-0c4f-3024-a034-1e0c79146d4c" }, "beneficiary": { "identity_type": "MEMBER", "member_id": "00000000-0000-0000-0000-000000000000" }, "namespace": "benefit_programs_app", "display_name": "New Program", "external_program_id": "myProgram17" }' ~~~ ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.benefitPrograms.ProgramService.provisionProgram(poolDefinitionLookupId, options) Description: 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. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: options.beneficiary, options.externalProgramId, options.namespace, options Method parameters: param name: options | type: ProvisionProgramOptions none | required: true - name: beneficiary | type: IdentificationData | description: Program beneficiary. | required: true - ONE-OF: - name: anonymousVisitorId | type: string | description: GUID of a site visitor that hasn't logged in to the site. - name: memberId | type: string | description: GUID of a site member. - name: wixUserId | type: string | description: GUID of a Wix user. - name: programStatus | type: ProgramStatus | description: Initial program status. Default: `ACTIVE` - enum: - ACTIVE: Program is active. - PAUSED: Program is paused. - name: namespace | type: string | description: Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created. | required: true - name: displayName | type: string | description: Program name. If you're provisioning the program from a program definition, you may want to use the same name that was used for the program definition. - name: externalProgramId | type: string | description: GUID for the program defined by you. You can use `externalId` to filter queries. | required: true param name: poolDefinitionLookupId | type: PoolDefinitionLookupId | required: true - ONE-OF: - required: true - name: poolDefinitionId | type: string | description: Pool definition GUID. - name: programDefinitionId | type: string | description: Program definition GUID. Return type: PROMISE - name: jobId | type: string | description: Job GUID of the provisioning of the program. Retrieve job details using the [Async Job API](https://dev.wix.com/docs/rest/business-management/async-job/introduction.md). - name: program | type: Program | description: Provisioned program. - name: _id | type: string | description: Program GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the program is updated. To prevent conflicting changes, the current revision must be specified when updating the program. Ignored when creating a program. - name: _createdDate | type: Date | description: Date and time the program was created. - name: _updatedDate | type: Date | description: Date and time the program was updated. - name: programDefinitionId | type: string | description: GUID of the associated program definition. - name: status | type: ProgramStatus | description: Program status. - enum: - ACTIVE: Program is active. - PAUSED: Program is paused. It can be resumed. - ENDED: Program has ended. It can't be resumed. - PROVISIONING: Program is being activated for the first time. This status exists for a short time during processing. - PAUSING: Program is being paused. This status exists for a short time during processing. - RESUMING: Program is being re-activated after being paused. This status exists for a short time during processing. - ENDING: Program is being ended. This status exists for a short time during processing. - name: beneficiary | type: IdentificationData | description: Program beneficiary. - ONE-OF: - name: anonymousVisitorId | type: string | description: GUID of a site visitor that hasn't logged in to the site. - name: memberId | type: string | description: GUID of a site member. - name: wixUserId | type: string | description: GUID of a Wix user. - name: displayName | type: string | description: Program name. You may want to use the same name that's used in the associated program definition, if it exists. - name: namespace | type: string | description: Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created. - name: extendedFields | type: ExtendedFields | description: Custom field data for the program object. [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions.md) must be configured in the app dashboard before they can be accessed with API calls. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: externalId | type: string | description: GUID for the program defined by you. You can use `externalId` to filter queries. - name: programDefinition | type: ProgramDefinitionInfo | description: Associated program definition information. - name: _id | type: string | description: Program definition GUID. - name: externalId | type: string | description: Program definition external GUID. Possible Errors: HTTP Code: 409 | Status Code: ALREADY_EXISTS | Application Code: IN_PROGRESS | Description: Program creation is in progress. HTTP Code: 409 | Status Code: ALREADY_EXISTS | Application Code: PROGRAM_ALREADY_EXISTS | Description: Program already exists with pools. ``` ### Examples ### Provision a benefit program ```javascript import { programs } from "@wix/benefit-programs"; const poolDefinitionLookupId = { programDefinitionId: "e8c3366e-0c4f-3024-a034-1e0c79146d4c", }; const beneficiary = { identityType: "MEMBER" as const, memberId: "00000000-0000-0000-0000-000000000000", }; async function provisionProgram() { const response = await programs.provisionProgram(poolDefinitionLookupId, { beneficiary, namespace: "benefit_programs_app", displayName: "New Program", externalProgramId: "myProgram17", }); } ``` ### provisionProgram (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { programs } from '@wix/benefit-programs'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { programs }, // Include the auth strategy and host as relevant }); async function provisionProgram(poolDefinitionLookupId,options) { const response = await myWixClient.programs.provisionProgram(poolDefinitionLookupId,options); }; ``` ---