goals
patch/api/goals/{goal_id}

Request

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
metadata_jsonunknown

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
metadata_jsonunknown
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

    • info

      removed the pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ from the request property /

    • info

      removed the pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ from the request property /

    • info

      the response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was removed for the status

    • info

      the / response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was removed for the status

    • info

      the response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was removed for the status

    • info

      the / response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was removed for the status