updatePolicy( )

Updates a policy.

The updatePolicy() function returns a Promise that resolves to the newly-updated policy.

Each time the policy is updated, revision increments by 1. The existing revision must be included when updating the policy. This ensures you're working with the latest policy and prevents unintended overwrites.

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 Events - all permissions
Manage Policies
Manage Events
Learn more about app permissions.
Method Declaration
Copy
function updatePolicy(_id: string, policy: UpdatePolicy): Promise<Policy>;
Method Parameters
_idstringRequired

Policy ID.

policyUpdatePolicyRequired

Policy to update.

Returns
Return Type:Promise<Policy>
JavaScript
import { policies } from "@wix/events";

async function updatePolicy(id, policy, options) {
  const response = await policies.updatePolicy(id, policy, options);
}
Errors

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

Did this help?