Skip to main content
POST
Book appointment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
calendarId
string
required

Calendar to book on. Get it from appointmentCalendars.list.

Pattern: ^\d+$
contactId
string
required

Contact id. Get it from contacts.list.

Pattern: ^\d+$
startAt
string<date-time>
required

Slot start time.

conversationId
string | null

Conversation to associate the booking with, if any.

Pattern: ^\d+$
inviteeTimezone
string

IANA timezone of the invitee, for display purposes.

Response

OK

id
string
required
calendarId
string
required
contactId
string
required
conversationId
string | null
required
startAt
string<date-time>
required
endAt
string<date-time>
required
inviteeTimezone
string
required
status
enum<string>
required
Available options:
scheduled,
cancelled
locationType
enum<string>
required
Available options:
inPerson,
phoneCall,
onlineMeeting
locationDetail
string | null
required
externalEventId
string | null
required
cancelledAt
string<date-time> | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required