> 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 # DeleteProgramDefinition # Package: benefitPrograms # Namespace: ProgramDefinitionService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/benefit-programs/program-definitions/delete-program-definition.md ## Permission Scopes: Manage benefit programs: SCOPE.BENEFIT_PROGRAMS.MANAGE ## Introduction Deletes a program definition. --- ## REST API ### Schema ``` Method: deleteProgramDefinition Description: Deletes a program definition. URL: https://www.wixapis.com/_api/benefit-programs/v1/program-definitions/{programDefinitionId} Method: DELETE # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: programDefinitionId Method parameters: param name: cascadeType | type: Cascade - enum: UNKNOWN_CASCADE - Unknown cascade. NEXT_RENEWAL - Changes are applied to existing programs and pools when they are next renewed. IMMEDIATELY - Changes are applied to associated programs and pools immediately. FUTURE_PROVISIONS - Changes are not applied to existing associated programs and pools. They are only applied to future programs and pools. param name: programDefinitionId | type: none | required: true Return type: DeleteProgramDefinitionResponse EMPTY-OBJECT {} ``` ### Examples ### DeleteProgramDefinition ```curl ~~~cURL curl --request DELETE \ https://www.wixapis.com/benefit-programs/v1/program-definitions/1f4ef6ff-7228-3c24-9fe2-252f18959285?cascadeType=IMMEDIATELY \ -H 'Authorization: ' \ -H "Content-Type: application/json" ~~~ ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.benefitPrograms.ProgramDefinitionService.deleteProgramDefinition(programDefinitionId, options) Description: Deletes a program definition. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: programDefinitionId Method parameters: param name: options | type: DeleteProgramDefinitionOptions none - name: cascadeType | type: Cascade | description: Determines when the changes to this program definition will be applied to associated programs and pools. - enum: - UNKNOWN_CASCADE: Unknown cascade. - NEXT_RENEWAL: Changes are applied to existing programs and pools when they are next renewed. - IMMEDIATELY: Changes are applied to associated programs and pools immediately. - FUTURE_PROVISIONS: Changes are not applied to existing associated programs and pools. They are only applied to future programs and pools. param name: programDefinitionId | type: string | description: GUID of the program definition to delete. | required: true Return type: PROMISE EMPTY-OBJECT {} ``` ### Examples ### deleteProgramDefinition ```javascript import { programDefinitions } from '@wix/benefit-programs'; async function deleteProgramDefinition(programDefinitionId,options) { const response = await programDefinitions.deleteProgramDefinition(programDefinitionId,options); }; ``` ### deleteProgramDefinition (with elevated permissions) ```javascript import { programDefinitions } from '@wix/benefit-programs'; import { auth } from '@wix/essentials'; async function myDeleteProgramDefinitionMethod(programDefinitionId,options) { const elevatedDeleteProgramDefinition = auth.elevate(programDefinitions.deleteProgramDefinition); const response = await elevatedDeleteProgramDefinition(programDefinitionId,options); } ``` ### deleteProgramDefinition (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 { programDefinitions } from '@wix/benefit-programs'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { programDefinitions }, // Include the auth strategy and host as relevant }); async function deleteProgramDefinition(programDefinitionId,options) { const response = await myWixClient.programDefinitions.deleteProgramDefinition(programDefinitionId,options); }; ``` ---