Skip to main content
POST
Create booking

Path Parameters

organisationId
string
required

The organisation ID

Example:

"org_31XEcUshz1ymodA14HALnyP48g1"

Body

application/json
locationId
string
required

Location ID

Example:

"27"

providerId
string
required

Provider ID

Example:

"54"

appointmentTypeId
string
required

Appointment type ID

Example:

"280"

appointmentTime
string<date-time>
required

Appointment time

Example:

"2025-01-01T10:00:00Z"

client
object
required
notes
string

Notes

Maximum string length: 1000
Example:

"Sore back for 4 weeks"

bookingCreditId
string

When set, redeem this plan booking credit (session) to cover the booking instead of taking card payment.

sessionId
string
payment
object
funding
object

Response

201 - application/json
id
string
required
createdAt
string<date-time>
required
locationId
string
required
location
object
required
status
enum<string>
required
Available options:
confirmed,
cancelled
providerId
string
required
provider
object
required
appointmentTypeId
string
required
appointmentType
object
required
serviceDate
string<date-time>
required
client
object
required
clientId
string
required
source
enum<string>
required
Available options:
pms,
halth,
unknown
paid
boolean
required
invoiced
boolean
required
adjustments
object[]
required
tags
enum<string>[]

Normalised attribute tags for the booking

Available options:
transaction_awaiting_payment,
payment_method_available,
health_fund_card_available
arrivalStatus
enum<string>
Available options:
did_not_arrive,
arrived
servicePrice
number
cancelledAt
string<date-time>
healthFundCard
object
paymentMethod
object
cancellationPolicy
object
latestTransaction
object
pmsBookingId
string
pmsAttendeeId
string