POST

Pause Loyalty Program


Changes the program status to PAUSED.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Loyalty
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/loyalty-programs/v1/program/pause

Request
This endpoint does not take any parameters.
Response Object
loyaltyProgramLoyaltyProgram

Paused loyalty program.

Pause loyalty program
Request
cURL
curl -X POST \ 'https://www.wixapis.com/loyalty-programs/v1/program/pause' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "loyaltyProgram": { "name": "Star Loyalty Program", "pointDefinition": { "customName": "Stars", "icon": { "id": "", "url": "shapes/39dce0a5d1ce498f95526b1390eaf585.svg", "height": 0, "width": 0 } }, "status": "PAUSED", "pointsExpiration": { "status": "DISABLED", "monthsOfInactivity": 3, "expiringPointsPercentage": 100 }, "premiumFeatures": { "loyaltyProgram": true, "tiers": true, "pointsExpiration": true }, "createdDate": "2022-05-22T08:18:32.186Z", "updatedDate": "2022-05-25T10:36:32.430Z" } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?