Onboarding

Complete user onboarding

post/api/users/onboarding

Request

  • Base URL
    https://api.hiyd.ai
  • Auth
    HTTP bearer

Request body

date_of_birthstring date required
gender'male' | 'female' | 'non_binary' | 'other' | 'prefer_not_to_say' required
height_cmnumber required
weight_kgnumber required
target_weight_kgnumber

Optional target weight

Example request

{
  "date_of_birth": "1990-01-01",
  "gender": "male",
  "height_cm": 175,
  "weight_kg": 70,
  "target_weight_kg": 68,
  "responses": [
    {
      "question_id": "00000000-0000-0000-0000-000000000101",
      "answer_ids": [
        "answer-uuid-1",
        "answer-uuid-2"
      ],
      "response_text": "I want to sleep better and have more energy."
    }
  ]
}

Response

Onboarding completed successfully

Changes

No recorded changes to this operation across all 1 revision of this API.