Create a patient

Create a new patient record. Requires OWNER or ADMIN role.

Authorization

AuthorizationRequiredBearer <token>

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

In: header

Request Body

application/jsonRequired

emailstring

Format: "email"

phonestring

firstNamestring

lastNamestring

dateOfBirthstring

Format: "date"

genderstring

addressstring

patientTypestring

Default: "prospect"Value in: "prospect" | "patient" | "lead"

patientStatusstring

Default: "active"Value in: "active" | "inactive" | "archived" | "discharged"

tagsarray<string>

customFieldsobject

curl -X POST "https://platform.caramedical.com/api/v1/patients" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "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": {}
  }'

Patient created successfully.

{
  "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"
}

Authorization

Request Body

Response

TypeScript