Skip to main content
PUT
Update Event

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json
id
string
required
status
enum<string> | null
Available options:
PENDING,
RESERVED,
CONFIRMED,
CANCELLED,
COMPLETED,
OVERRIDABLE,
NO_SHOW
title
string | null
organizerId
string | null
start
string<date-time> | null
end
string<date-time> | null
locationId
string | null
roomId
string | null
type
enum<string> | null
Available options:
APPOINTMENT,
SHIFT,
BLOCK,
GOOGLE_CALENDAR
attendeeIds
string[] | null
segments
(EventServiceCreate · object | EventBookableSegmentCreate · object | EventPrepSegmentCreate · object | EventCleanupSegmentCreate · object)[] | null

Service segment creation request.

bookableIds
string[] | null
recurringEvent
RecurringEventRequest · object | null

Request schema for recurring events.

Use segments for appointments that need provider assignments per service. Use service_ids for shifts/blocks that don't require provider-specific assignments.

recurrenceModificationMode
enum<string> | null

Enum representing the different modes for handling recurring event modifications Used when modifying recurring events to specify which occurrences should be affected

Available options:
this,
future,
all
confirmationText
string | null
tz
string | null
capacity
integer | null
description
string | null
patientRequestedProvider
boolean | null
isBusinessBlock
boolean | null

Response

Successful Response

events
EventDetail · object[]
required
googleCalendarFailures
GoogleCalendarSyncFailure · object[]