Skip to main content
POST
Hold a slot

Authorizations

Authorization
string
header
required

Marketplace API key

Headers

x-session-token
string

The App Bridge token of the logged-in user (maxcare.appToken()), verified for this app and organization. With it the EHR is read through that user's own EHR login when they have a usable one on this EHR instance, else through the organization's system connector; without it, always the system connector. meta.actingAs says which. A token that does not verify is 401 authorizer_unverified. Sent as a header so GET requests keep it out of URLs.

X-Organization-Id
string
required

Target clinic organization ID

Body

application/json
providerId
string
required

Provider ID (prv_…)

facilityId
string
required

Facility ID (fac_…)

appointmentTypeId
string
required

Appointment type ID (atp_…)

startsAt
string
required

Slot start, ISO-8601 with explicit offset

Example:

"2026-08-03T08:00:00-04:00"

durationMinutes
number
required

Slot length in minutes

Example:

15

ttlSeconds
number

Hold lifetime in seconds (30–1800). Defaults to 600.

Example:

600

Response

Success

code
string
required

Response code

Example:

"success"

data
object
required