Skip to content

Update settings

Changes your daily targets, display preferences or body measurements. Only what you send changes.

PATCHhttps://app.splot.health/v1/settings

Needs the Read and write permission.

Send any of targets, preferences and body. A field you leave out keeps its value.

FieldTypeDescription
targetsobjectA change to your daily targets, from a day on.
preferencesobjectDisplay preferences. Only what you send changes; null clears a field.
bodyobjectBody measurements. Only what you send changes; null clears a field.

A change applies from from, and earlier days keep their targets. Add through to change only those days: the day after it goes back to the targets it had. Send values as null to have no targets from from.

FieldTypeDescription
fromdateRequired. The first day the change applies, usually today. Earlier days keep their targets.
valuesobject or nullRequired. All four targets, or null to have no targets from from.
throughdateThe last day the change applies, inclusive. Leave out to keep it from then on.

values needs all four targets:

FieldTypeDescription
caloriesKcalnumberRequired. Energy, in kcal.
proteinGnumberRequired. Protein, in grams.
carbsGnumberRequired. Carbohydrates, in grams.
fatGnumberRequired. Fat, in grams.
FieldTypeDescription
unitsstring or nullThe units to show amounts in; imperial is US customary. null follows the phone. One of metric, imperial or uk.
deviceUnitsstringThe units the phone uses, as the app last reported them. One of metric, imperial or uk.
showTargetsbooleanWhether the app shows progress towards your targets.
assistantShortcutstring or nullThe assistant the app's shortcut opens, or off. One of claude, chatgpt or off.
FieldTypeDescription
weightKgnumber or nullWeight, in kilograms.
heightCmnumber or nullHeight, in centimetres.
ageinteger or nullAge, in years. From 1 to 130.
sexstring or nullSex, for estimating energy needs. One of female, male or unspecified.
activitystring or nullHow active a usual day is. One of sitting, somewhat or very.

200 with your settings after the change.

Terminal window
curl -X PATCH https://app.splot.health/v1/settings \
-H "Authorization: Bearer $SPLOT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"targets": { "from": "2026-10-06", "values": { "caloriesKcal": 2000, "proteinG": 130, "carbsG": 220, "fatG": 65 } }
}'

Last updated