Skip to main content
PATCH
Update Goal

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <omi_developer_api_key>.

Path Parameters

goal_id
string
required

Body

application/json
current_value
number | null

New progress value

desired_outcome
string | null
Maximum string length: 2000
horizon_at
string<date-time> | null
max_value
number | null

New maximum value

min_value
number | null

New minimum value

success_criteria
string[] | null
Maximum array length: 20
target_value
number | null

New target value

title
string | null

New title

Required string length: 1 - 500
unit
string | null

New unit label

why_it_matters
string | null
Maximum string length: 2000

Response

Successful Response

created_at
string<date-time>
required
current_value
number
required
desired_outcome
string
required
goal_id
string
required
goal_type
string
required
id
string
required
is_active
boolean
required
max_value
number
required
min_value
number
required
source
string
required
status
string
required
target_value
number
required
title
string
required
updated_at
string<date-time>
required
focus_rank
integer | null
horizon_at
string<date-time> | null
metric
GoalMetric · object | null
success_criteria
string[]
unit
string | null
why_it_matters
string | null