pauseProgram( )

Pauses the specified program. Benefits in the program's pools can't be redeemed until the program is resumed.

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
programIdstringRequired

ID of the program to pause.

optionsPauseProgramOptionsRequired
Returns
Return Type:Promise<PauseProgramResponse>
Errors
409Already Exists

There are 2 errors with this status code.

428Failed Precondition

There is 1 error with this status code.

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

Did this help?