Skip to content

Attach a patient to a self-scheduling attempt

Request

Resolves or creates a patient from the provided demographics and attaches them to the self-scheduling attempt. If the attempt has a verified identity proof, patient resolution will use it for matching. Returns 200 if an existing patient was found, 201 if a new patient was created.

Security
PartnerApiKey and PartnerOAuth
Path
attemptIdinteger, (int64)required
Bodyapplication/jsonrequired
dateOfBirthstring, non-empty^\d{4}-\d{2}-\d{2}$required

Date of birth in yyyy-MM-dd format

Example:"1985-10-26"
emailstring, (email)

Patient email address

Example:"jane.doe@example.com"
firstNamestring, non-emptyrequired

Patient first name

Example:"Jane"
lastNamestring, non-emptyrequired

Patient last name

Example:"Doe"
phonestring^\d{10}$

Patient phone number (10 digits)

Example:"5551234567"
curl -i -X POST \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/self-scheduling/attempt/{attemptId}/patient' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "dateOfBirth": "1985-10-26",
    "email": "jane.doe@example.com",
    "firstName": "Jane",
    "lastName": "Doe",
    "phone": "5551234567"
  }'

Responses

Existing patient attached to self-scheduling attempt

Bodyapplication/json
activeboolean

Whether the patient is active. false indicates an archived or merged-away record.

Example:true
createdAtstring, (date-time)

Creation timestamp (UTC)

Example:"2025-01-15T14:00:00Z"
dateOfBirthstring, (date)

Patient's date of birth in ISO 8601 format (YYYY-MM-DD)

Example:"1990-01-15"
emailstring, (email)

Patient's email address

Example:"john.doe@example.com"
firstNamestring, <= 255 characters

Patient's first name

Example:"John"
genderstring

Patient's gender

Example:"male"
homeAddressobject(PatientAddressDTO)

Structured postal address

idinteger, (int64)

Unique patient identifier

Example:12345
lastNamestring, <= 255 characters

Patient's last name

Example:"Doe"
mailingAddressobject(PatientAddressDTO)

Structured postal address

mobilePhonestring

Patient's mobile phone number (digits only, no formatting)

Example:"14155551234"
primaryLocationIdinteger, (int64)

ID of the patient's primary location

Example:1312
primaryProviderIdinteger, (int64)

ID of the patient's primary provider (practitioner)

Example:987
updatedAtstring, (date-time)

Last update timestamp (UTC)

Example:"2025-01-15T14:00:00Z"
Response
{
  "active": true,
  "createdAt": "2025-01-15T14:00:00Z",
  "dateOfBirth": "1990-01-15",
  "email": "john.doe@example.com",
  "firstName": "John",
  "gender": "male",
  "homeAddress": {
    "city": "San Francisco",
    "line1": "123 Main St",
    "line2": "Apt 4B",
    "postalCode": "94105",
    "stateRegion": "CA"
  },
  "id": 12345,
  "lastName": "Doe",
  "mailingAddress": {
    "city": "San Francisco",
    "line1": "123 Main St",
    "line2": "Apt 4B",
    "postalCode": "94105",
    "stateRegion": "CA"
  },
  "mobilePhone": "14155551234",
  "primaryLocationId": 1312,
  "primaryProviderId": 987,
  "updatedAt": "2025-01-15T14:00:00Z"
}