updateReferralProgram( )

Updates a referral program. Supports partial updates.

Revision number, which increments by 1 each time the referral program is updated. To prevent conflicting changes, the current revision must be passed when updating the referral program.

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
Manage Referrals
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
function updateReferralProgram(
  referralProgram: ReferralProgram,
): Promise<UpdateReferralProgramResponse>;
Method Parameters
referralProgramReferralProgramRequired

Referral program to update. Include the latest revision for a successful update.

Returns
Return Type:Promise<UpdateReferralProgramResponse>
JavaScript
import { programs } from "@wix/referral";

async function updateReferralProgram(referralProgram) {
  const response = await programs.updateReferralProgram(referralProgram);
}
Errors

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

Did this help?