reorderEventPolicies( )

Changes policy order in an event dashboard and agreement checkbox on the checkout form. For example, if we have 3 policies in the list, after using this function the 3rd policy will become the 1st, and other policies will move by 1 position. By default, the policies are arranged by the created date in descending order.

Note: it is possible to use both beforePolicyId and afterPolicyId at the same time but only the last one defined will be executed.

The reorderEventPolicies() function returns a Promise that resolves to the newly-reordered policy.

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 reorderEventPolicies(
  policyId: string,
  eventId: string,
  options: ReorderEventPoliciesOptions,
): Promise<ReorderEventPoliciesResponse>;
Method Parameters
policyIdstringRequired

Event policy ID.

eventIdstringRequired

Event ID.

optionsReorderEventPoliciesOptions

Options for Reorder Event Policies function.

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

async function reorderEventPolicies(policyId, eventId, options) {
  const response = await policies.reorderEventPolicies(
    policyId,
    eventId,
    options,
  );
}
Errors

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

Did this help?