In documentation code examples, replace <API_KEY_VALUE> with the session token.
Body
application/vnd.mx.nexus.v1+json
goal
object
Hide child attributes
goal.account_guid
string
required
Unique identifier for the goal. Defined by MX.
Example:
"ACT-4e431124-4a29-abf9-f059-ab232ac14dbf"
goal.amount
number
required
The amount of the goal.
Example:
4500
goal.goal_type_name
string
required
The type of goal. Can be SAVE_AMOUNT or PAYOFF.
Example:
"string"
goal.meta_type_name
string
required
The category of the goal; see Goal Meta Type for more information.
Example:
"VACATION"
goal.name
string
required
The name of the goal that is visible to the user (i.e., "Europe Trip", "Savings", "Toyota Tacoma", etc).
Example:
"Save for Europe."
goal.completed_at
string
Date and time the goal was completed, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00).
Example:
"2015-06-19T10:37:04-06:00"
goal.has_been_spent
boolean
If the goal has been spent, this field will be true. Otherwise, this field will be false.
Example:
false
goal.is_complete
boolean
If the goal is complete, this field will be true. Otherwise, this field will be false.
Example:
false
goal.metadata
string
Additional information a partner can store on the goal.
Example:
"Additional information"
goal.position
integer
The priority of the goal in relation to multiple goals.
Example:
3
goal.skip_webhook
boolean
When set to true, this parameter will prevent a webhook from being triggered by the request.
Example:
true
goal.targeted_to_complete_at
string
Date and time the goal is to complete, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00). Intended for users to set their own goal completion dates.
goal.track_type_name
string
The track of the goal. Can be DEBT_TRACK, SAVINGS_TRACK, RETIREMENT_TRACK, or EMERGENCY_FUND_TRACK.
Response
200 - application/vnd.mx.nexus.v1+json
OK
goal
object
Hide child attributes
goal.account_guid
string
Unique identifier for the goal. Defined by MX.
Example:
"ACT-4e431124-4a29-abf9-f059-ab232ac14dbf"
goal.amount
number
The amount of the goal.
Example:
4500
goal.goal_type_name
string
The type of goal. Can be SAVE_AMOUNT or PAYOFF.
Example:
"string"
goal.meta_type_name
string
The category of the goal; see Goal Meta Type for more information.
Example:
"VACATION"
goal.name
string
The name of the goal that is visible to the user (i.e., "Europe Trip", "Savings", "Toyota Tacoma", etc).
Example:
"Save for Europe."
goal.completed_at
string
Date and time the goal was completed, represented in ISO 8601 format with timestamp (e.g. 2015-04-13T12:01:23-00:00).
Example:
"2015-06-19T10:37:04-06:00"
goal.has_been_spent
boolean
If the goal has been spent, this field will be true. Otherwise, this field will be false.
Example:
false
goal.is_complete
boolean
If the goal is complete, this field will be true. Otherwise, this field will be false.
Example:
false
goal.metadata
string
Additional information a partner can store on the goal.
Example:
"Additional information"
goal.position
integer
The priority of the goal in relation to multiple goals.
Example:
3
goal.track_type_name
string
The track of the goal. Can be DEBT_TRACK, SAVINGS_TRACK, RETIREMENT_TRACK, or EMERGENCY_FUND_TRACK.