> 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 # ResumeProgram # Package: benefitPrograms # Namespace: ProgramService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/benefit-programs/programs/resume-program.md ## Permission Scopes: Manage benefit programs: SCOPE.BENEFIT_PROGRAMS.MANAGE ## Introduction Resumes the specified program. Call this method for paused programs. --- ## REST API ### Schema ``` Method: resumeProgram Description: Resumes the specified program. Call this method for paused programs. URL: https://www.wixapis.com/benefit-programs/v1/programs/resume Method: POST # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: programId, idempotencyKey Method parameters: param name: idempotencyKey | type: idempotencyKey | description: Idempotency key to ensure that the request is processed only once. | required: true param name: programId | type: programId | description: GUID of program to resume. | required: true Return type: ResumeProgramResponse - name: jobId | type: string | description: Job GUID of the resuming of the program. Retrieve job details using the [Async Job API](https://dev.wix.com/docs/rest/business-management/async-job/introduction.md). Possible Errors: HTTP Code: 409 | Status Code: ALREADY_EXISTS | Application Code: IN_PROGRESS | Description: Program resuming is in progress. HTTP Code: 409 | Status Code: ALREADY_EXISTS | Application Code: ALREADY_EXECUTED | Description: Program was already resumed. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: PROGRAM_STATUS_TRANSITION_NOT_ALLOWED | Description: Program isn't paused and can't be resumed. ``` ### Examples ### ResumeProgram ```curl ~~~cURL curl --request POST https://www.wixapis.com/benefit-programs/v1/programs/resume \ -H "Content-Type: application/json" \ -H "Authorization: " \ --data '{ "program_id": "e5c42e1e-cd10-4210-b483-bb59932b1fa7" }' ~~~ ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.benefitPrograms.ProgramService.resumeProgram(programId, options) Description: Resumes the specified program. Call this method for paused programs. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: programId, options.idempotencyKey, options Method parameters: param name: options | type: ResumeProgramOptions none | required: true - name: idempotencyKey | type: string | description: Idempotency key to ensure that the request is processed only once. | required: true param name: programId | type: string | description: GUID of program to resume. | required: true Return type: PROMISE - name: jobId | type: string | description: Job GUID of the resuming of the program. Retrieve job details using the [Async Job API](https://dev.wix.com/docs/rest/business-management/async-job/introduction.md). Possible Errors: HTTP Code: 409 | Status Code: ALREADY_EXISTS | Application Code: IN_PROGRESS | Description: Program resuming is in progress. HTTP Code: 409 | Status Code: ALREADY_EXISTS | Application Code: ALREADY_EXECUTED | Description: Program was already resumed. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: PROGRAM_STATUS_TRANSITION_NOT_ALLOWED | Description: Program isn't paused and can't be resumed. ``` ### Examples ### resumeProgram ```javascript import { programs } from '@wix/benefit-programs'; async function resumeProgram(programId,options) { const response = await programs.resumeProgram(programId,options); }; ``` ### resumeProgram (with elevated permissions) ```javascript import { programs } from '@wix/benefit-programs'; import { auth } from '@wix/essentials'; async function myResumeProgramMethod(programId,options) { const elevatedResumeProgram = auth.elevate(programs.resumeProgram); const response = await elevatedResumeProgram(programId,options); } ``` ### resumeProgram (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 resumeProgram(programId,options) { const response = await myWixClient.programs.resumeProgram(programId,options); }; ``` ---