--- title: "Creates a new patient after onboarding." method: POST path: "/patients/onboarding" tags: ["patients onboarding"] --- # Creates a new patient after onboarding. `POST /patients/onboarding` ## Request body - PatientOnboardingRequest - `age` number, nullable — age as an integer representing years - `birthday` string, nullable — calendar date in format YYYY-MM-DD - `diagnosis_feeling` string, nullable - `diet_restrictions` CreatePatientDietRestrictionRequest[], nullable - `comment` string, nullable - `name` string, required - `email` string, required - `first_meal_time` string, nullable — time in format hh:mm:ss - `first_name` string, required - `last_name` string, required - `motivations` CreatePatientMotivationRequest[], nullable - `comment` string, nullable — text for 'other' types, or other user comments. Max 256 char - `name` string, required - `password` string, required - `phone_number` string, nullable - `sex` 'female' | 'male' | 'intersex' | 'mtf_female' | 'ftm_male', nullable ## Response `200` successful operation - PatientResponse - `birthday` string — calendar date in format YYYY-MM-DD - `country_of_residence` string, nullable - `created_time` string, date-time, required - `diagnosis_feeling` string, nullable - `diet_restrictions` PatientDietRestrictionResponse[] - `comment` string, nullable - `id` integer, required - `name` string, required - `name_translations` object, nullable - `email` string, required - `email_verified` boolean, required - `first_meal_time` string, time, nullable - `first_name` string, required - `flags` RxFeatureFlagsResponse, required - `auditor_reviewer_is_external` boolean - `clinic_admin_api_access` boolean - `clinic_allow_cross_hospital_report_access` boolean - `clinic_auto_log_photos_enabled` boolean - `clinic_default_days_until_report_date` string - `clinic_default_mark_patients_as_priority` boolean - `clinic_default_patient_age` string - `clinic_default_patient_sex` string - `clinic_default_report_include_supplements_in_food_dump` boolean - `clinic_default_report_include_supplements_in_rdi` boolean - `clinic_default_sms_enabled` boolean - `clinic_default_subscription_name` string - `clinic_default_user_locale` string - `clinic_enable_clinician_advisor_chat` boolean - `clinic_invitation_email_cadence` string - `clinic_maximum_meal_capture_period_in_days_before_subscription` string - `clinic_report_autogenerate` boolean - `clinic_report_full_automation` boolean - `clinic_report_identity_mode` 'normal' | 'anonymous' | 'identifier_patient_id' | 'identifier_external_id' | 'identifier_both_ids' - `clinic_report_judge_confidence_min` string, nullable - `clinic_send_repeat_subscription_invitation_email` boolean - `clinic_send_subscription_invitation_email` boolean - `clinic_show_patient_report_secure_link` boolean - `clinic_subscription_reminder_email_cadence` string - `clinic_subscription_types` string - `clinician_allow_meal_edit` boolean - `clinician_autopilot_enabled` boolean - `clinician_available_trial_lengths` string - `clinician_can_delete_meals` boolean - `clinician_can_generate_reports` boolean - `clinician_can_view_clinic_invite_code` boolean - `clinician_meal_planner_enabled` boolean - `clinician_oversight_of_patient` 'clinician' | 'non-clinician' - `clinician_patient_allow_cal_carb_toggle` boolean - `clinician_patient_allow_macro_card_toggle` boolean - `clinician_patient_allow_mindful_eating_survey_toggle` boolean - `clinician_patient_allow_patient_app_coaching_tab_toggle` boolean - `clinician_prevent_new_patients_after_date` string, nullable - `clinician_report_24h_turnaround` boolean - `clinician_report_disable_early_generation` boolean - `clinician_require_mfa` boolean - `clinician_show_timeline` boolean - `email_template_id_clinic_logging_completion` string - `email_template_id_clinic_logging_starts_tomorrow` string - `email_template_id_clinic_onboarding` string - `email_template_id_clinic_registered_but_no_meals` string - `email_template_id_clinic_reminder_to_continue_logging` string - `email_template_id_clinic_report_available` string - `email_template_id_clinic_thirty_day_subscription_inactive_logging_reminder` string - `email_template_id_clinic_upcoming_subscription` string - `email_template_id_returning_invitation` string - `hospital_patient_custom_fields_json` string - `hospital_patient_has_external_id` boolean - `lifecycle_messaging_variant_patient_invited` string - `lifecycle_messaging_variant_patient_logging_completed` string - `lifecycle_messaging_variant_patient_report_available` string - `lifecycle_messaging_variant_patient_subscription_notification` string - `lifecycle_messaging_variant_patient_subscription_reminder` string - `patient_app_care_team_experience` boolean - `patient_app_coaching_tab` boolean - `patient_app_extended_logging_types` string, nullable - `patient_app_guided_health_program` boolean - `patient_app_hide_meal_after_n_hours` string, nullable - `patient_app_hide_nutrition_starplot` boolean, nullable - `patient_app_key_nutrients` string, nullable - `patient_app_mindful_eating_survey` boolean - `patient_app_nutritional_insights` boolean - `patient_app_nutritional_insights_sections_to_hide` string, nullable - `patient_app_partner_branding` string, nullable - `patient_app_partner_movano` boolean - `patient_app_partner_oauth_provider` string, nullable - `patient_app_pii_minimal_masking` boolean, nullable - `patient_app_primary_macronutrient` string, nullable - `patient_app_primary_macronutrient_can_edit` boolean - `patient_app_show_dev_settings` boolean - `patient_app_show_diet_score` boolean - `patient_app_show_macro_nutrition_card` boolean - `patient_app_show_nutrition_data_and_insights` boolean - `patient_app_show_schedule_call_with_doctor` boolean - `patient_app_use_care_team_version` boolean - `patient_app_use_timeline` boolean - `patient_app_use_v3_ui` boolean - `patient_app_v2_care_team_ui` boolean - `patient_can_view_pdf_reports` boolean - `patient_default_measure_system` string - `patient_enforce_subscription` boolean - `patient_glucose_units_mmol_l` boolean - `patient_goals_can_edit` boolean - `patient_preferred_nutrition_source` string - `patient_report_quality_judge` boolean - `patient_send_meal_reminders` boolean — this is still configurable by the patient, unless it is False - then all the alerts are blocked. - `patient_show_cals` boolean - `patient_show_carbs` boolean - `patient_show_dexcom_oauth` boolean - `patient_show_gender` boolean - `patient_show_total_carbs` boolean - `patient_use_exercise` boolean - `patient_use_medication` boolean - `patient_use_question` boolean - `patient_use_sleep` boolean - `user_require_password_strength` boolean - `flags_raw` object - `id` integer, required - `is_active` boolean, required - `is_gender_enabled` boolean, nullable - `is_priority` boolean - `is_registered` boolean, required - `is_shown_carbs` boolean - `last_name` string, required - `locale` string, nullable - `meal_time_breakfast` string, time, nullable - `meal_time_dinner` string, time, nullable - `meal_time_lunch` string, time, nullable - `motivations` PatientMotivationResponse[] - `comment` string, nullable - `id` integer, required - `name` string, required - `name_translations` object, nullable - `patient_type` 'research' | 'collaboration' | 'wellness' | 'obesity' | 'diabetes' | 'metabolic syndrome' | 'weight loss' | 'migraine' | 'gastroesophageal reflux' | 'gi discomfort' | 'vertigo' | 'sleep apnea' | 'dexcom' | 'rxlife' | 'menopause', nullable - `phone_number` string, nullable - `recent_meal_context` string[] - `sex` 'female' | 'male' | 'intersex' | 'mtf_female' | 'ftm_male', nullable - `state` string, nullable - `subscriptions` PatientSubscriptionResponse[] - `clinic_id` integer - `completion_time` string, date-time - `created_by_user_id` integer, nullable - `created_time` string, date-time, required - `expiration_date` string, required — calendar date in format YYYY-MM-DD - `hospital_id` integer - `id` integer, required - `is_complete` boolean - `is_logging_complete` boolean - `logging_completion_time` string, date-time - `name` 'three-day' | 'five-day' | 'seven-day' | 'ten-day' | 'one-month' | 'cgm14' | '14-day' | '21-day' | '28-day' | 'custom', required — name of the subscription - `notified_of_logging_completion` boolean - `notified_of_logging_completion_time` string, date-time - `patient_id` integer, required - `report_date` string — calendar date in format YYYY-MM-DD. - `start_date` string, required — calendar date in format YYYY-MM-DD - `subscription_length` integer, nullable - `type` 'single' | 'weekly' | 'monthly' | 'bi-weekly' | '4-weeks' | 'custom', required - `updated_time` string, date-time, required - `tracking_start_date` string, required - `updated_time` string, date-time, required - `usage_summary` PatientUsageSummary - `summary_statistics` PatientUsageSummaryStatistics, required - `date_since` string, required — calendar date in format YYYY-MM-DD - `date_until` string, required — calendar date in format YYYY-MM-DD - `number_of_days_prior_to_reference` integer — number of days not included because they were in the time range but before the reference date - `number_of_inactive_days` integer — number of inactive days in the time period - `number_of_meal_items_logged` integer — number of meal_items logged in the time period - `number_of_meals_logged` integer — number of meals logged in the time period - `number_of_tracked_days` integer — number of days tracked in the time period - `tracking_reference_date` string — calendar date in format YYYY-MM-DD - `use_data_screen` boolean, nullable - `use_exercise` boolean, nullable - `use_fast_entry_audio` boolean - `use_fast_entry_photo` boolean - `use_fast_entry_text` boolean - `use_local_photo` boolean - `use_medication` boolean, nullable - `use_question` boolean, nullable - `use_search_by_photo` boolean - `use_search_by_text` boolean - `use_sleep` boolean, nullable - `zipcode` string, nullable --- [API](https://skmtc.dev/rxfoodapp/apis/inneranalytics-mnt-server.md) · [All operations](https://skmtc.dev/rxfoodapp/apis/inneranalytics-mnt-server/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/rxfoodapp/inneranalytics-mnt-server/revisions/0703cbbbefe8/schema)