restoreEventDefaults( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Restores the event's default values from the relevant schedule or MASTER event.

You must provide fields to specify which inheritedFields are restored.

For example, if you've created an event that takes place in a non-default location with a custom title and capacity, but you want to reset only title and capacity to default values without affecting the location, provide the event ID and set fields to ["TITLE", "CAPACITY"].

Refer to the default values article for more information.

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 Bookings - all permissions
Manage Bookings
Manage Calendars
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
eventIdstringRequired

ID of the event for which to restore default values.

fieldsArray<Field>Required

Fields for which to restore default values.

TIME restores default values for start and end.

Min: 1 field

optionsRestoreEventDefaultsOptions
Returns
Return Type:Promise<RestoreEventDefaultsResponse>
Errors

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

Did this help?