Sign in
sleep

Modifies an existing sleep log

put/patients/{patient_id}/sleep/{patient_sleep_id}

Path parameters

patient_idinteger required
patient_sleep_idinteger required

Request body

notestring nullable

note that can be added to provide additional description Max 1024 char

sleep_end_date_timestring required

datetime in format YYYY-MM-DD HH:MM:SS

sleep_start_date_timestring required

datetime in format YYYY-MM-DD HH:MM:SS

sleep_type'inBed' | 'asleepUnspecified' | 'awake' | 'asleepCore' | 'asleepDeep' | 'asleepREM' required
sourcestring nullable

source of sleep data

source_idstring nullable

id of sleep from source

Example request

{
  "sleep_end_date_time": "2019-01-02 08:00:00",
  "sleep_start_date_time": "2019-01-02 08:00:00",
  "source": "healthkit",
  "source_id": "35C09300-FAB6-460E-95B5-8EF4EC5663A3"
}

Response

successful operation

idinteger required
notestring nullable

note that can be added to provide additional description Max 1024 char

sleep_end_date_timestring required

datetime in format YYYY-MM-DD HH:MM:SS

sleep_group_start_date_timestring

datetime in format YYYY-MM-DD HH:MM:SS

sleep_start_date_timestring required

datetime in format YYYY-MM-DD HH:MM:SS

sleep_type'inBed' | 'asleepUnspecified' | 'awake' | 'asleepCore' | 'asleepDeep' | 'asleepREM' required
sourcestring nullable

source of sleep data

source_idstring nullable

id of sleep from source

Changes

No recorded changes to this endpoint across all 15 revisions of this API.