PATCH

Activate Referral Program


Activates the referral program, changing its status to ACTIVE.

Endpoint
PATCH
https://www.wixapis.com/_api/referral-programs/v1/program/activate

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

Activated referral program.

Activate Referral Program
Request
cURL
curl -X PATCH \ 'https://www.wixapis.com/_api/referral-programs/v1/program/activate' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "referralProgram": { "name": "Share & Earn", "status": "ACTIVE", "revision": "3", "createdDate": "2024-01-01T10:49:25.803Z", "updatedDate": "2024-01-02T10:49:25.803Z", "referredFriendReward": { "type": "LOYALTY_POINTS", "loyaltyPointsOptions": { "amount": 1 } }, "referringCustomerReward": { "type": "LOYALTY_POINTS", "loyaltyPointsOptions": { "amount": 1 } }, "successfulReferralActions": ["STORE_ORDER_PLACED"], "emails": { "encourageToReferFriends": ["STORES"], "notifyCustomersAboutReward": true }, "premiumFeatures": { "referralProgram": true } } }
Errors

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

Event TriggersThis method triggers the following events:
Did this help?