Skip to content

Create appointment for self-scheduling attempt

Request

Creates an appointment for the specified self-scheduling attempt. Patient must be set on the attempt before creating an appointment. Scheduler config must belong to the self-scheduling setting.

Security
PartnerApiKey and PartnerOAuth
Path
attemptIdinteger, (int64)required
Bodyapplication/jsonrequired
appointmentTypeIdinteger, (int64)required

Appointment type ID

Example:10
locationIdinteger, (int64)required

Location ID

Example:1
practitionerIdinteger, (int64)required

Practitioner ID

Example:7
schedulerConfigIdinteger, (int64)required

Scheduler config ID (must belong to the self-scheduling setting)

Example:101
startDateTimestringrequired

Appointment start time in ISO 8601 format with timezone

Example:"2025-01-15T10:00:00-08:00"
curl -i -X POST \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/self-scheduling/attempt/{attemptId}/appointment' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "appointmentTypeId": 10,
    "locationId": 1,
    "practitionerId": 7,
    "schedulerConfigId": 101,
    "startDateTime": "2025-01-15T10:00:00-08:00"
  }'

Responses

Appointment created successfully

Bodyapplication/json
appointmentTypeIdinteger, (int64)

Appointment type ID

Example:10
endDateTimestring

Appointment end time in ISO 8601 format with timezone

Example:"2025-01-15T10:30:00-08:00"
formCountinteger, (int32)

Number of forms to be completed by the patient

Example:3
idinteger, (int64)

Appointment ID

Example:999
locationIdinteger, (int64)

Location ID

Example:1
practitionerIdinteger, (int64)

Practitioner ID

Example:7
startDateTimestring

Appointment start time in ISO 8601 format with timezone

Example:"2025-01-15T10:00:00-08:00"
statusstring

Appointment status (one of: SCHEDULED, CANCELLED, NO_SHOW, CHECKED_IN, IN_TREATMENT, CHECKED_OUT, CONFIRMED, RESCHEDULED, VOIDED)

Example:"SCHEDULED"
telehealthboolean

Whether this is a telehealth appointment

Example:false
Response
{
  "appointmentTypeId": 10,
  "endDateTime": "2025-01-15T10:30:00-08:00",
  "formCount": 3,
  "id": 999,
  "locationId": 1,
  "practitionerId": 7,
  "startDateTime": "2025-01-15T10:00:00-08:00",
  "status": "SCHEDULED",
  "telehealth": false
}