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
integer
required
The Id of the CalendarEvent record to update.
integer
required
ID of the location this event belongs to..
string
required
Name of the event displayed on the Members Portal; required..
string
required
Event start date and time in UTC; must be before EndDate..
string
required
Event end date and time in UTC; must be after StartDate..
integer
required
Recurrence cycle for the series: Daily, Weekly, Monthly, Yearly, FirstOfMonth, SecondOfMonth, ThirdOfMonth, FourthOfMonth, or LastOfMonth..
integer
required
For an update to a recurring event, selects the scope: UpdateThisEventOnly, UpdateFutureEventsOnly, UpdateAllEvents, DeleteAllEvents, DeleteEventsAfterThis, or UpdateEventProducts..
Optional Fields
string
Full name of the person hosting or presenting the event..
string
Short plain-text summary shown under the event name on the Members Portal..
string
Full HTML description shown when a customer opens the event on the Members Portal..
string
Additional notes appended to ticket confirmation emails..
boolean
Whether customers can join a waiting list when the event is at full capacity..
boolean
Whether to request the buyer’s postal address during ticket checkout..
boolean
Whether the attendee list is displayed on the Members Portal event page..
string
Venue or room name displayed on the event page; changing it notifies registered attendees..
string
Street address of the event venue..
integer
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..
integer
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..
integer[]
List of category IDs for this event; an empty list means the event has no categories..
integer[]
IDs added to the EventCategories relationship..
integer[]
IDs removed from the EventCategories relationship..
string
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..
boolean
Whether this event is displayed in the home page banner on the Members Portal..
boolean
Whether this event is displayed on the Members Portal home page..
boolean
Whether customers can post comments on the event..
boolean
Whether the system creates a Zoom conference call for this event and shares the link with attendees..
boolean
Whether to create a Zoom webinar instead of a regular conference call for this event..
string
Comma-separated email addresses of alternative Zoom hosts who can start the webinar..
string
Internal raw Zoom meeting payload maintained by the Zoom integration..
string
Internal Zoom meeting or webinar identifier maintained by the Zoom integration..
boolean
Whether only customers without an active contract (contacts) can view and attend this event..
boolean
Whether only customers with an active contract (members) can view and attend this event..
string
URL of an image to upload as the small event image.
boolean
Remove the current small event image.
string
URL of an image to upload as the large event image.
boolean
Remove the current large event image.
string
Optional URL of an external website related to this event..
string
Optional URL of a Facebook event or page for this event..
string
Optional URL of an external ticketing page for this event..
string
System-generated identifier shared by all occurrences in a recurring series; use it to find and update all events in that series..
boolean
Whether to create this event as a recurring series; only applies when creating the first event in the series..
integer
Optional positive number of cycles between occurrences; for example, 2 with Weekly repeats every two weeks..
string
Optional final UTC date for creating occurrences in the recurring series; when omitted, occurrences are created for one year..
boolean
Whether the recurring series includes Mondays..
boolean
Whether the recurring series includes Tuesdays..
boolean
Whether the recurring series includes Wednesdays..
boolean
Whether the recurring series includes Thursdays..
boolean
Whether the recurring series includes Fridays..
boolean
Whether the recurring series includes Saturdays..
boolean
Whether the recurring series includes Sundays..
string
System-maintained local-time representation of StartDate; set StartDate (UTC) instead..
string
System-maintained local-time representation of EndDate; set EndDate (UTC) instead..
string
System-maintained local-time representation of PublishDate; set PublishDate (UTC) instead..
string
Internal background job identifier for the scheduled post-event notification email..
boolean
Whether a follow-up notification email is sent to all attendees after the event ends..
string
Custom message body for the post-event notification email..
boolean
Whether a reminder email is sent to attendees within 24 hours before the event starts..
boolean
Whether a form is linked to this event that attendees are asked to complete; the system sets this automatically from FormPage..
boolean
Whether the linked event form is sent to attendees by email, including follow-up reminders..
integer
Optional ID of the form page attendees are asked to complete for this event..
integer[]
List of plan IDs that restrict this event to members subscribed to those plans; an empty list means no plan restriction..
integer[]
IDs added to the Tariffs relationship..
integer[]
IDs removed from the Tariffs relationship..
integer[]
List of customer IDs that restrict this event to those specific customers; an empty list means no customer restriction..
integer[]
IDs added to the Members relationship..
integer[]
IDs removed from the Members relationship..
integer[]
List of team IDs that restrict this event to customers belonging to those teams; an empty list means no team restriction..
integer[]
IDs added to the Teams relationship..
integer[]
IDs removed from the Teams relationship..
Code Examples
Response
200
integer
HTTP status code.
200 on success.string
A human-readable message confirming the update.
object
Contains the
Id of the updated record.boolean
true if the calendarevent was updated successfully.array
null on success.Example Response
400
string
A summary of the validation error(s), in the format
PropertyName: error message.any
null on validation failure.object[]
Array of validation errors.
boolean
false when the request fails validation.Example Response