Skip to main content
POST
Create Appointment

Authorizations

Authorization
string
header
required

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

Body

application/json
type
string
required

Appointment type, company specific

Example:

"video"

providerId
string<uuid>
required
startDate
string
required
Example:

"2024-11-20T07:43:34+0000"

endDate
string
required
Example:

"2024-11-20T07:43:34+0000"

createdAt
string
Example:

"2024-11-20T07:43:34+0000"

status
enum<string>
default:upcoming
Available options:
upcoming,
occurred,
cancelled,
no-show,
re-scheduled
memberId
string | null
actualStartDate
string | null
Example:

"2024-11-20T07:43:34+0000"

actualEndDate
string | null
Example:

"2024-11-20T07:43:34+0000"

location
string | null
cancellationDate
string | null

Only present when status = cancelled

Example:

"2024-11-20T07:43:34+0000"

cancellationReason
string | null

Only present when status = cancelled

Response

id
string<uuid>
required
createdAt
string
required
Example:

"2024-11-20T07:43:34+0000"

type
string
required

Appointment type, company specific

Example:

"video"

status
enum<string>
required
Available options:
upcoming,
occurred,
cancelled,
no-show,
re-scheduled
providerId
string<uuid>
required
memberId
string | null
required
startDate
string
required
Example:

"2024-11-20T07:43:34+0000"

endDate
string
required
Example:

"2024-11-20T07:43:34+0000"

actualStartDate
string | null
required
Example:

"2024-11-20T07:43:34+0000"

actualEndDate
string | null
required
Example:

"2024-11-20T07:43:34+0000"

location
string | null
required
cancellationDate
string | null
required

Only present when status = cancelled

Example:

"2024-11-20T07:43:34+0000"

cancellationReason
string | null
required

Only present when status = cancelled