CalendarEvents
Update CalendarEvent
Update an existing CalendarEvent record.
PUT
Update CalendarEvent
Updates an existing CalendarEvent record. You must include the
Id of the record to update along with all required fields.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the CalendarEvent-Edit role.Enums
eCalendarEventRepeatCycle — Repeats values
eCalendarEventRepeatCycle — Repeats values
eRepeatedCalendarEventUpdateAction — WhichEventsToUpdate values
eRepeatedCalendarEventUpdateAction — WhichEventsToUpdate values
Request Body
Required Fields
Recurrence cycle for the series: Daily, Weekly, Monthly, Yearly, FirstOfMonth, SecondOfMonth, ThirdOfMonth, FourthOfMonth, or LastOfMonth..
For an update to a recurring event, selects the scope: UpdateThisEventOnly, UpdateFutureEventsOnly, UpdateAllEvents, DeleteAllEvents, DeleteEventsAfterThis, or UpdateEventProducts..
Optional Fields
Optional ID of the bookable resource held for this event; it blocks that resource from being booked during the event’s start and end times..
Maximum total number of attendees for the event; leave empty for unlimited. The effective capacity is the lower of this value and the sum of the ticket products’ allocations..
UTC date and time the event becomes visible on the Members Portal; the system rounds it down to the nearest 15 minutes. Leave empty to keep the event unpublished..
Whether the system creates a Zoom conference call for this event and shares the link with attendees..
Whether only customers without an active contract (contacts) can view and attend this event..
System-generated identifier shared by all occurrences in a recurring series; use it to find and update all events in that series..
Whether to create this event as a recurring series; only applies when creating the first event in the series..
Optional positive number of cycles between occurrences; for example, 2 with Weekly repeats every two weeks..
Optional final UTC date for creating occurrences in the recurring series; when omitted, occurrences are created for one year..
Whether a form is linked to this event that attendees are asked to complete; the system sets this automatically from FormPage..
List of plan IDs that restrict this event to members subscribed to those plans; an empty list means no plan restriction..
List of customer IDs that restrict this event to those specific customers; an empty list means no customer restriction..
List of team IDs that restrict this event to customers belonging to those teams; an empty list means no team restriction..
Code Examples
Response
200
Example Response
400
Example Response