Events
Update Event
Partially update an event in your organization
PATCH
Update Event
Partially updates an event. Only the fields supplied in the body are written — omitted fields are left unchanged. The event must belong to the organization associated with the API key; cross-org requests return404 Not Found with no information leak.
Requires the events:write scope.
Path Parameters
string
required
Event ID (the canonical 20-character document ID, e.g.
AbCdEfGhIjKlMnOpQrSt).Request Body
At least one field is required. Unknown fields are rejected with400.
string
Event name (1–200 chars). Triggers a taxonomy + search-relevance
re-index in the background.
string
Long-form description shown on the event page. Triggers a re-index.
object
object | null
Same shape as
start. Pass null to clear the end time (open-ended
event). When both start and end are present, end must be strictly
after start and the timezones must match.object
Replace any of the venue fields. Existing venue fields not present in
the patch are NOT preserved — the full object you supply is what gets
written, so include every field you want to keep.
string
Convenience — a
https://... URL is stored as the virtual meeting
link, anything else is stored as venue.address. If you need finer
control over venue fields, use venue instead.integer
Maximum number of tickets that can be sold.
0 means unlimited.string
ISO-4217 currency code.
boolean
Hide the event from public listings.
boolean
Whether ticket prices are tax-inclusive.
boolean
Allow attendees to RSVP (maybe / not going) in addition to confirming.
string
Public URL of the cover image.
enum
open or closed. When closed, the public registration form is
hidden and new bookings are rejected. Existing attendees are unaffected.enum
none, email, or email_and_phone. Controls what an attendee must
provide on the registration form.boolean
Absorb service fees into the ticket price rather than adding them at
checkout.
object
Restrict registrations to specific contact lists.
Response
Returns the updated event as serialized byGET /events/{event_id}.
