Create Lead

Create Lead

curl --request POST \
  --url https://uk.api.aiosmedical.com/external/v1/leads \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "data": {
    "surname": "Doe",
    "forename": "John",
    "phone": "+44 7700 900123",
    "gender": "Male",
    "ethnicity": "White British",
    "dateOfBirth": "1990-01-01",
    "billingAddress": {
      "addressLine1": "123 High Street",
      "addressLine2": "Flat 2B",
      "city": "London",
      "state": "England",
      "region": "Greater London",
      "zipCode": "SW1A 1AA"
    },
    "shippingAddress": {
      "addressLine1": "123 High Street",
      "addressLine2": "Flat 2B",
      "city": "London",
      "state": "England",
      "region": "Greater London",
      "zipCode": "SW1A 1AA"
    },
    "height": {
      "unit": "metric",
      "feet": "5",
      "inches": "10",
      "cm": "178"
    },
    "weight": {
      "unit": "metric",
      "kg": "75",
      "stones": "11",
      "pounds": "165"
    },
    "goalWeight": {
      "unit": "metric",
      "kg": "75",
      "stones": "11",
      "pounds": "165"
    },
    "prescriptionMedication": [
      {
        "medication": "Metformin",
        "reason": "Type 2 Diabetes"
      }
    ],
    "surgeries": [
      {
        "value": "Appendectomy",
        "intervalTime": "2 years ago",
        "details": "Laparoscopic appendectomy, no complications"
      }
    ],
    "weightLossInjections": {
      "drugName": "Ozempic",
      "strength": "1mg",
      "weightPriorToTreatment": "85kg"
    },
    "allergicReactionToWeightLossInjections": {
      "description": "Nausea and dizziness after injection"
    },
    "medicalConditions": [
      {
        "condition": "Diabetes",
        "desc": "Type 2 diabetes diagnosed in 2020",
        "kidneyDiseaseType": "Chronic kidney disease stage 3"
      }
    ],
    "healthConditions": [
      {
        "condition": "Diabetes",
        "desc": "Type 2 diabetes diagnosed in 2020",
        "kidneyDiseaseType": "Chronic kidney disease stage 3"
      }
    ],
    "familyHistoryOfMedicalConditions": {
      "value": "Heart disease",
      "relation": "Father"
    },
    "allergyToMedicationOrSupplement": "Penicillin"
  }
}
'

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "[email protected]",
  "data": {
    "name": "John Doe",
    "email": "[email protected]",
    "phone": "1234567890",
    "address": "123 Main St, Anytown, USA"
  },
  "createdAt": "2025-06-04T12:00:00.000Z"
}

POST

external

leads

Create Lead

curl --request POST \
  --url https://uk.api.aiosmedical.com/external/v1/leads \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "data": {
    "surname": "Doe",
    "forename": "John",
    "phone": "+44 7700 900123",
    "gender": "Male",
    "ethnicity": "White British",
    "dateOfBirth": "1990-01-01",
    "billingAddress": {
      "addressLine1": "123 High Street",
      "addressLine2": "Flat 2B",
      "city": "London",
      "state": "England",
      "region": "Greater London",
      "zipCode": "SW1A 1AA"
    },
    "shippingAddress": {
      "addressLine1": "123 High Street",
      "addressLine2": "Flat 2B",
      "city": "London",
      "state": "England",
      "region": "Greater London",
      "zipCode": "SW1A 1AA"
    },
    "height": {
      "unit": "metric",
      "feet": "5",
      "inches": "10",
      "cm": "178"
    },
    "weight": {
      "unit": "metric",
      "kg": "75",
      "stones": "11",
      "pounds": "165"
    },
    "goalWeight": {
      "unit": "metric",
      "kg": "75",
      "stones": "11",
      "pounds": "165"
    },
    "prescriptionMedication": [
      {
        "medication": "Metformin",
        "reason": "Type 2 Diabetes"
      }
    ],
    "surgeries": [
      {
        "value": "Appendectomy",
        "intervalTime": "2 years ago",
        "details": "Laparoscopic appendectomy, no complications"
      }
    ],
    "weightLossInjections": {
      "drugName": "Ozempic",
      "strength": "1mg",
      "weightPriorToTreatment": "85kg"
    },
    "allergicReactionToWeightLossInjections": {
      "description": "Nausea and dizziness after injection"
    },
    "medicalConditions": [
      {
        "condition": "Diabetes",
        "desc": "Type 2 diabetes diagnosed in 2020",
        "kidneyDiseaseType": "Chronic kidney disease stage 3"
      }
    ],
    "healthConditions": [
      {
        "condition": "Diabetes",
        "desc": "Type 2 diabetes diagnosed in 2020",
        "kidneyDiseaseType": "Chronic kidney disease stage 3"
      }
    ],
    "familyHistoryOfMedicalConditions": {
      "value": "Heart disease",
      "relation": "Father"
    },
    "allergyToMedicationOrSupplement": "Penicillin"
  }
}
'

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "[email protected]",
  "data": {
    "name": "John Doe",
    "email": "[email protected]",
    "phone": "1234567890",
    "address": "123 Main St, Anytown, USA"
  },
  "createdAt": "2025-06-04T12:00:00.000Z"
}

Body

application/json

string<email>

Example:

"[email protected]"

data

object

Show child attributes

data.surname

string

Example:

"Doe"

data.forename

string

Example:

"John"

data.phone

string

Example:

"+44 7700 900123"

data.gender

string

Example:

"Male"

data.ethnicity

string

Example:

"White British"

data.dateOfBirth

string

Example:

"1990-01-01"

data.billingAddress

object

Show child attributes

data.billingAddress.addressLine1

string

Example:

"123 High Street"

data.billingAddress.addressLine2

string

Example:

"Flat 2B"

data.billingAddress.city

string

Example:

"London"

data.billingAddress.state

string

Example:

"England"

data.billingAddress.region

string

Example:

"Greater London"

data.billingAddress.zipCode

string

Example:

"SW1A 1AA"

data.shippingAddress

object

Show child attributes

data.shippingAddress.addressLine1

string

Example:

"123 High Street"

data.shippingAddress.addressLine2

string

Example:

"Flat 2B"

data.shippingAddress.city

string

Example:

"London"

data.shippingAddress.state

string

Example:

"England"

data.shippingAddress.region

string

Example:

"Greater London"

data.shippingAddress.zipCode

string

Example:

"SW1A 1AA"

data.height

object

Show child attributes

data.height.unit

string

Example:

"metric"

data.height.feet

string

Example:

"5"

data.height.inches

string

Example:

"10"

data.height.cm

string

Example:

"178"

data.weight

object

Show child attributes

data.weight.unit

string

Example:

"metric"

data.weight.kg

string

Example:

"75"

data.weight.stones

string

Example:

"11"

data.weight.pounds

string

Example:

"165"

data.goalWeight

object

Show child attributes

data.goalWeight.unit

string

Example:

"metric"

data.goalWeight.kg

string

Example:

"75"

data.goalWeight.stones

string

Example:

"11"

data.goalWeight.pounds

string

Example:

"165"

data.prescriptionMedication

object[]

Show child attributes

data.prescriptionMedication.medication

string

Example:

"Metformin"

data.prescriptionMedication.reason

string

Example:

"Type 2 Diabetes"

data.surgeries

object[]

Show child attributes

data.surgeries.value

string

Example:

"Appendectomy"

data.surgeries.intervalTime

string

Example:

"2 years ago"

data.surgeries.details

string

Example:

"Laparoscopic appendectomy, no complications"

data.weightLossInjections

object

Show child attributes

data.weightLossInjections.drugName

string

Example:

"Ozempic"

data.weightLossInjections.strength

string

Example:

"1mg"

data.weightLossInjections.weightPriorToTreatment

string

Example:

"85kg"

data.allergicReactionToWeightLossInjections

object

Show child attributes

data.allergicReactionToWeightLossInjections.description

string

Example:

"Nausea and dizziness after injection"

data.medicalConditions

object[]

Show child attributes

data.medicalConditions.condition

string

Example:

"Diabetes"

data.medicalConditions.desc

string

Example:

"Type 2 diabetes diagnosed in 2020"

data.medicalConditions.kidneyDiseaseType

string

Example:

"Chronic kidney disease stage 3"

data.healthConditions

object[]

Show child attributes

data.healthConditions.condition

string

Example:

"Diabetes"

data.healthConditions.desc

string

Example:

"Type 2 diabetes diagnosed in 2020"

data.healthConditions.kidneyDiseaseType

string

Example:

"Chronic kidney disease stage 3"

data.familyHistoryOfMedicalConditions

object

Show child attributes

data.familyHistoryOfMedicalConditions.value

string

Example:

"Heart disease"

data.familyHistoryOfMedicalConditions.relation

string

Example:

"Father"

data.allergyToMedicationOrSupplement

string

Example:

"Penicillin"

Response

Lead created successfully

string

Example:

"123e4567-e89b-12d3-a456-426614174000"

string

Example:

"[email protected]"

data

object

Example:

{
  "name": "John Doe",
  "email": "[email protected]",
  "phone": "1234567890",
  "address": "123 Main St, Anytown, USA"
}

createdAt

string

Example:

"2025-06-04T12:00:00.000Z"

Introduction Get Weightloss Protocol

⌘I

API Documentation

Leads

Clinic Protocols

Prescriptions

Body

Response