Skip to main content
POST
Set goal

Authorizations

Authorization
string
header
required

Environment AUTH_KEY. Full ledger access and primary API-key administration. Not OAuth or JWT.

Headers

Idempotency-Key
string
required
Required string length: 1 - 128
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]*$

Body

application/json
metric
enum<string>
required
Available options:
measurement:weight,
nutrient:energy_kcal,
nutrient:protein_g,
nutrient:carbohydrate_g,
nutrient:fat_g,
nutrient:fiber_g,
hydration:water_ml,
activity:active_energy_kcal,
activity:exercise_minutes
target
number
required
Required range: x <= 1000000000000
expected_version
integer
required
Required range: 0 <= x <= 2147483646
unit
string
Required string length: 1 - 20
baseline
number
Required range: x <= 1000000000000

Response

Committed mutation or durable idempotent replay

catalog_version
string
required
Allowed value: "1.0.4"
goal
object
required
committed_version
integer
required
Required range: x <= 2147483647
idempotent_replay
boolean
required