Developers

Book a scheduled appointment

Creates a scheduled appointment for a specific future time slot. The slot must be one returned by GET /appointments/scheduled/available-slots/ for the provided location.state.

POST/appointments/scheduled/

Creates a scheduled appointment for a specific future time slot. The slot must be one returned by GET /appointments/scheduled/available-slots/ for the provided location.state.

Authorization

HTTPBearer XDoctronicUserID
AuthorizationBearer <token>

In: header

X-Doctronic-User-ID<token>

Doctronic user ID returned as data.id by POST /users/. This value identifies the user in your organization scope; it is not an API token.

In: header

Header Parameters

Idempotency-Key?string

Unique key for safely retrying this mutation for 24 hours. Reuse the same key only with the same request payload.

Lengthlength <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/appointments/scheduled/" \  -H "Content-Type: application/json" \  -d '{    "chatId": "string",    "startsAt": "2019-08-24T14:15:22Z",    "location": {      "state": "AK"    }  }'
{  "code": "success",  "message": "Request successful",  "data": {    "id": "string",    "createdAt": "2019-08-24T14:15:22Z",    "chatId": "string",    "status": "booked",    "durationMinutes": 0,    "location": {      "state": "AK"    }  }}

List available scheduled appointment slots GET

Returns available appointment start times filtered to practitioners credentialed in the provided US state.

Book an ASAP appointment POST

Places the patient in a shared waiting room immediately. A practitioner credentialed in the given state will join when available: there is no guaranteed wait time.