Skip to main content
PATCH
Update Event
Updates an event. Host-only — the caller must be in hostIds (service/master keys bypass this). Every provided field is updated; omitted fields are left untouched. Type-conditional location validation is re-applied when type is present. hostIds, status, and spaceId are not editable here — manage hosts via the host endpoints, cancel via Cancel Event; the space is immutable. Images can be curated in one request: a new cover replaces the existing cover, gallery files are appended, and removeImageIds deletes existing event images by File ID. Any image operation requires the files-images bundle. When a time field (startTime/endTime/timezone) or a location field (location/url/venueName/address) actually changes, an event-updated notification is fanned out to all going/maybe RSVPs (best-effort, requires the notifications bundle).

Path Parameters

string
required
UUID of the event to update.

Body Parameters

string
Event title. 1–300 characters.
string
New description.
string
New ISO start datetime.
string
New ISO end datetime.
string
New IANA timezone.
string
"online", "physical", or "hybrid". Re-triggers location validation.
string
Join/stream URL.
string
Venue name.
string
Street address.
{ latitude: number; longitude: number }
New coordinates. On multipart requests, send as a JSON string.
string
"public", "members", or "invite".
number
New capacity (positive integer).
boolean
Whether "maybe" RSVPs are allowed.
boolean
Whether non-hosts can view the guest list.
object
Arbitrary key-value data. Up to 1 MB.
string[]
File IDs of existing event images to remove (gallery photos and/or the current cover). Each must belong to this event. On multipart requests, send as a JSON string.
file
New cover image (replaces the current cover). Multipart file field. Requires cover.options.
string
JSON-stringified image-processing options for the new cover.
Gallery images to append (up to 10). Multipart file field. Requires gallery.options.
JSON-stringified image-processing options for the appended gallery images.

Response

Returns the updated Event object.

Error Responses

See also: useUpdateEvent