Book an appointment

Book an appointment for a patient.

Authorization

AuthorizationRequiredBearer <token>

Use your API key (sk_live_* or sk_test_*) as the Bearer token.

In: header

Request Body

application/jsonRequired

patientIdRequiredstring

providerIdstring

datetimeRequiredstring

Format: "date-time"

durationinteger

Duration in minutes.

Default: 30

typestring

notesstring

curl -X POST "https://platform.caramedical.com/api/v1/scheduling/book" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "patientId": "string",
    "providerId": "string",
    "datetime": "2019-08-24T14:15:22Z",
    "duration": 30,
    "type": "string",
    "notes": "string"
  }'

Appointment booked.

{
  "id": "string",
  "patientId": "string",
  "providerId": "string",
  "datetime": "2019-08-24T14:15:22Z",
  "duration": 0,
  "status": "scheduled",
  "type": "string",
  "notes": "string",
  "patient": {
    "id": "pat_1706000000_abc123def",
    "externalId": "string",
    "joiningCode": "PULSE-A1B2C3D4",
    "email": "user@example.com",
    "phone": "+15551234567",
    "firstName": "string",
    "lastName": "string",
    "dateOfBirth": "2019-08-24",
    "gender": "string",
    "address": "string",
    "patientType": "prospect",
    "patientStatus": "active",
    "tags": [
      "string"
    ],
    "customFields": {},
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "createdAt": "2019-08-24T14:15:22Z"
}

Authorization

Request Body

Response

TypeScript