goals

Update Goal

patch/api/goals/{goal_id}

Path parameters

goal_idstring uuid required

Headers

X-Workspace-Idstring nullable

Request body

namestring nullable

currencystring nullable

target_datestring date nullable

tracking_typestring nullable

account_idstring uuid nullable

asset_idstring uuid nullable

asset_group_idstring uuid nullable

statusstring nullable

iconstring nullable

colorstring nullable

positioninteger nullable

{"stackTrail":"components:schemas:GoalUpdate:properties:metadata_json:anyOf","oasType":"schema","type":"unknown","title":"Metadata Json","nullable":true}

Response

Successful Response

idstring uuid required

user_idstring uuid required

namestring required

target_amountstring required

current_amountstring required

currencystring required

target_amount_primarystring nullable

current_amount_primarystring nullable

target_datestring date nullable

tracking_typestring required

account_idstring uuid nullable

asset_idstring uuid nullable

asset_group_idstring uuid nullable

statusstring required

iconstring nullable

colorstring nullable

positioninteger required

{"stackTrail":"components:schemas:GoalRead:properties:metadata_json:anyOf","oasType":"schema","type":"unknown","title":"Metadata Json","nullable":true}

created_atstring date-time required

updated_atstring date-time required

percentagenumber

monthly_contributionnumber nullable

on_trackstring nullable

account_namestring nullable

asset_namestring nullable

asset_group_namestring nullable

Changes

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