Create self-scheduling attempt

Request

Initialize a new self-scheduling attempt. Validates that the setting is active and, if provided, that the identity proof matches the setting's verification requirements.

Security

PartnerApiKey and PartnerOAuth

Bodyapplication/jsonrequired

identityProofIdinteger, (int64)

Optional ID of a pre-created identity proof. If provided, verification method must match the setting.

Example:456

selfSchedulingSettingIdinteger, (int64)required

ID of the self-scheduling configuration to use

Example:123

curl -i -X POST \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/self-scheduling/attempt' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "identityProofId": 456,
    "selfSchedulingSettingId": 123
  }'

Responses

Attempt created successfully

Bodyapplication/json

appointmentIdinteger, (int64)

Appointment ID if appointment has been created. Omitted if not yet created.

Example:202

idinteger, (int64)

Attempt ID

Example:789

identityProofIdinteger, (int64)

Associated identity proof ID

Example:456

isVerifiedboolean

Whether all required verification methods have been completed

Example:true

patientIdinteger, (int64)

Patient ID if patient has been set (AccountPatient ID). Omitted if not yet set.

Example:101

selfSchedulingSettingIdinteger, (int64)

Associated self-scheduling setting ID

Example:123

Response

{
  "appointmentId": 202,
  "id": 789,
  "identityProofId": 456,
  "isVerified": true,
  "patientId": 101,
  "selfSchedulingSettingId": 123
}