pauseProgram( )


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

Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
SCOPE.BENEFIT_PROGRAMS.MANAGE
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsPauseProgramOptionsRequired

programIdstringRequired

ID of the program to pause.

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?