updateEvent( )

Developer Preview

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

Updates an event.

When updating an event with {"recurrenceType": "INSTANCE"}, the recurrenceType automatically changes to EXCEPTION.

When updating an event with {"recurrenceType": "MASTER"}:

  • Past INSTANCE and EXCEPTION events remain unchanged.
  • For future INSTANCE events, all relevant fields are updated.
  • For future EXCEPTION events, only changes to the inheritedFields are applied, while other fields remain unchanged.
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
_idstringRequired

Event ID.

eventUpdateEventRequired
optionsUpdateEventOptions
Returns
Return Type:Promise<Event>
JavaScript
Errors

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

Did this help?