Update a goal
curl --request PUT \
--url https://int-api.mx.com/users/{user_guid}/goals/{goal_guid} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"goal": {
"account_guid": "ACT-4e431124-4a29-abf9-f059-ab232ac14dbf",
"amount": 4500.5,
"goal_type_name": "PAYOFF",
"meta_type_name": "VACATION",
"name": "Save for Europe",
"completed_at": "2015-06-19T10:37:04-06:00",
"has_been_spent": false,
"is_complete": false,
"metadata": "Additional information",
"position": 3,
"targeted_to_complete_at": "2026-12-08 00:00:00.000000"
}
}
'import requests
url = "https://int-api.mx.com/users/{user_guid}/goals/{goal_guid}"
payload = { "goal": {
"account_guid": "ACT-4e431124-4a29-abf9-f059-ab232ac14dbf",
"amount": 4500.5,
"goal_type_name": "PAYOFF",
"meta_type_name": "VACATION",
"name": "Save for Europe",
"completed_at": "2015-06-19T10:37:04-06:00",
"has_been_spent": False,
"is_complete": False,
"metadata": "Additional information",
"position": 3,
"targeted_to_complete_at": "2026-12-08 00:00:00.000000"
} }
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
goal: {
account_guid: 'ACT-4e431124-4a29-abf9-f059-ab232ac14dbf',
amount: 4500.5,
goal_type_name: 'PAYOFF',
meta_type_name: 'VACATION',
name: 'Save for Europe',
completed_at: '2015-06-19T10:37:04-06:00',
has_been_spent: false,
is_complete: false,
metadata: 'Additional information',
position: 3,
targeted_to_complete_at: '2026-12-08 00:00:00.000000'
}
})
};
fetch('https://int-api.mx.com/users/{user_guid}/goals/{goal_guid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://int-api.mx.com/users/{user_guid}/goals/{goal_guid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'goal' => [
'account_guid' => 'ACT-4e431124-4a29-abf9-f059-ab232ac14dbf',
'amount' => 4500.5,
'goal_type_name' => 'PAYOFF',
'meta_type_name' => 'VACATION',
'name' => 'Save for Europe',
'completed_at' => '2015-06-19T10:37:04-06:00',
'has_been_spent' => false,
'is_complete' => false,
'metadata' => 'Additional information',
'position' => 3,
'targeted_to_complete_at' => '2026-12-08 00:00:00.000000'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://int-api.mx.com/users/{user_guid}/goals/{goal_guid}"
payload := strings.NewReader("{\n \"goal\": {\n \"account_guid\": \"ACT-4e431124-4a29-abf9-f059-ab232ac14dbf\",\n \"amount\": 4500.5,\n \"goal_type_name\": \"PAYOFF\",\n \"meta_type_name\": \"VACATION\",\n \"name\": \"Save for Europe\",\n \"completed_at\": \"2015-06-19T10:37:04-06:00\",\n \"has_been_spent\": false,\n \"is_complete\": false,\n \"metadata\": \"Additional information\",\n \"position\": 3,\n \"targeted_to_complete_at\": \"2026-12-08 00:00:00.000000\"\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://int-api.mx.com/users/{user_guid}/goals/{goal_guid}")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"goal\": {\n \"account_guid\": \"ACT-4e431124-4a29-abf9-f059-ab232ac14dbf\",\n \"amount\": 4500.5,\n \"goal_type_name\": \"PAYOFF\",\n \"meta_type_name\": \"VACATION\",\n \"name\": \"Save for Europe\",\n \"completed_at\": \"2015-06-19T10:37:04-06:00\",\n \"has_been_spent\": false,\n \"is_complete\": false,\n \"metadata\": \"Additional information\",\n \"position\": 3,\n \"targeted_to_complete_at\": \"2026-12-08 00:00:00.000000\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://int-api.mx.com/users/{user_guid}/goals/{goal_guid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"goal\": {\n \"account_guid\": \"ACT-4e431124-4a29-abf9-f059-ab232ac14dbf\",\n \"amount\": 4500.5,\n \"goal_type_name\": \"PAYOFF\",\n \"meta_type_name\": \"VACATION\",\n \"name\": \"Save for Europe\",\n \"completed_at\": \"2015-06-19T10:37:04-06:00\",\n \"has_been_spent\": false,\n \"is_complete\": false,\n \"metadata\": \"Additional information\",\n \"position\": 3,\n \"targeted_to_complete_at\": \"2026-12-08 00:00:00.000000\"\n }\n}"
response = http.request(request)
puts response.read_body{
"goal": {
"account_guid": "ACT-4e431124-4a29-abf9-f059-ab232ac14dbf",
"amount": 4500,
"completed_at": "2015-06-19T10:37:04-06:00",
"current_amount": 1651.27,
"goal_type_name": "PAYOFF",
"guid": "GOL-f223463-4355-48d0-rce7-fe2rb345617c",
"has_been_spent": false,
"is_complete": false,
"metadata": "Additional information",
"meta_type_name": "VACATION",
"name": "Save for Europe",
"position": 3,
"projected_to_complete_at": "2022-06-14T16:03:53-00:00",
"targeted_to_complete_at": "2026-12-08 00:00:00.000000",
"track_type_name": "Track Type Name",
"user_guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
}
}Goals
Update a goal
This endpoint updates a specific goal.
PUT
/
users
/
{user_guid}
/
goals
/
{goal_guid}
Update a goal
curl --request PUT \
--url https://int-api.mx.com/users/{user_guid}/goals/{goal_guid} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"goal": {
"account_guid": "ACT-4e431124-4a29-abf9-f059-ab232ac14dbf",
"amount": 4500.5,
"goal_type_name": "PAYOFF",
"meta_type_name": "VACATION",
"name": "Save for Europe",
"completed_at": "2015-06-19T10:37:04-06:00",
"has_been_spent": false,
"is_complete": false,
"metadata": "Additional information",
"position": 3,
"targeted_to_complete_at": "2026-12-08 00:00:00.000000"
}
}
'import requests
url = "https://int-api.mx.com/users/{user_guid}/goals/{goal_guid}"
payload = { "goal": {
"account_guid": "ACT-4e431124-4a29-abf9-f059-ab232ac14dbf",
"amount": 4500.5,
"goal_type_name": "PAYOFF",
"meta_type_name": "VACATION",
"name": "Save for Europe",
"completed_at": "2015-06-19T10:37:04-06:00",
"has_been_spent": False,
"is_complete": False,
"metadata": "Additional information",
"position": 3,
"targeted_to_complete_at": "2026-12-08 00:00:00.000000"
} }
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
goal: {
account_guid: 'ACT-4e431124-4a29-abf9-f059-ab232ac14dbf',
amount: 4500.5,
goal_type_name: 'PAYOFF',
meta_type_name: 'VACATION',
name: 'Save for Europe',
completed_at: '2015-06-19T10:37:04-06:00',
has_been_spent: false,
is_complete: false,
metadata: 'Additional information',
position: 3,
targeted_to_complete_at: '2026-12-08 00:00:00.000000'
}
})
};
fetch('https://int-api.mx.com/users/{user_guid}/goals/{goal_guid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://int-api.mx.com/users/{user_guid}/goals/{goal_guid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'goal' => [
'account_guid' => 'ACT-4e431124-4a29-abf9-f059-ab232ac14dbf',
'amount' => 4500.5,
'goal_type_name' => 'PAYOFF',
'meta_type_name' => 'VACATION',
'name' => 'Save for Europe',
'completed_at' => '2015-06-19T10:37:04-06:00',
'has_been_spent' => false,
'is_complete' => false,
'metadata' => 'Additional information',
'position' => 3,
'targeted_to_complete_at' => '2026-12-08 00:00:00.000000'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://int-api.mx.com/users/{user_guid}/goals/{goal_guid}"
payload := strings.NewReader("{\n \"goal\": {\n \"account_guid\": \"ACT-4e431124-4a29-abf9-f059-ab232ac14dbf\",\n \"amount\": 4500.5,\n \"goal_type_name\": \"PAYOFF\",\n \"meta_type_name\": \"VACATION\",\n \"name\": \"Save for Europe\",\n \"completed_at\": \"2015-06-19T10:37:04-06:00\",\n \"has_been_spent\": false,\n \"is_complete\": false,\n \"metadata\": \"Additional information\",\n \"position\": 3,\n \"targeted_to_complete_at\": \"2026-12-08 00:00:00.000000\"\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://int-api.mx.com/users/{user_guid}/goals/{goal_guid}")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"goal\": {\n \"account_guid\": \"ACT-4e431124-4a29-abf9-f059-ab232ac14dbf\",\n \"amount\": 4500.5,\n \"goal_type_name\": \"PAYOFF\",\n \"meta_type_name\": \"VACATION\",\n \"name\": \"Save for Europe\",\n \"completed_at\": \"2015-06-19T10:37:04-06:00\",\n \"has_been_spent\": false,\n \"is_complete\": false,\n \"metadata\": \"Additional information\",\n \"position\": 3,\n \"targeted_to_complete_at\": \"2026-12-08 00:00:00.000000\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://int-api.mx.com/users/{user_guid}/goals/{goal_guid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"goal\": {\n \"account_guid\": \"ACT-4e431124-4a29-abf9-f059-ab232ac14dbf\",\n \"amount\": 4500.5,\n \"goal_type_name\": \"PAYOFF\",\n \"meta_type_name\": \"VACATION\",\n \"name\": \"Save for Europe\",\n \"completed_at\": \"2015-06-19T10:37:04-06:00\",\n \"has_been_spent\": false,\n \"is_complete\": false,\n \"metadata\": \"Additional information\",\n \"position\": 3,\n \"targeted_to_complete_at\": \"2026-12-08 00:00:00.000000\"\n }\n}"
response = http.request(request)
puts response.read_body{
"goal": {
"account_guid": "ACT-4e431124-4a29-abf9-f059-ab232ac14dbf",
"amount": 4500,
"completed_at": "2015-06-19T10:37:04-06:00",
"current_amount": 1651.27,
"goal_type_name": "PAYOFF",
"guid": "GOL-f223463-4355-48d0-rce7-fe2rb345617c",
"has_been_spent": false,
"is_complete": false,
"metadata": "Additional information",
"meta_type_name": "VACATION",
"name": "Save for Europe",
"position": 3,
"projected_to_complete_at": "2022-06-14T16:03:53-00:00",
"targeted_to_complete_at": "2026-12-08 00:00:00.000000",
"track_type_name": "Track Type Name",
"user_guid": "USR-11141024-90b3-1bce-cac9-c06ced52ab4c"
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
The unique identifier for a goal. Defined by MX.
The unique identifier for a user, beginning with the prefix USR-.
Body
application/json
Hide child attributes
Hide child attributes
Unique identifier of the account for the goal.
Example:
"ACT-4e431124-4a29-abf9-f059-ab232ac14dbf"
Amount of the goal.
Example:
4500.5
The goal type.
Example:
"PAYOFF"
The category of the goal.
Example:
"VACATION"
The name of the goal.
Example:
"Save for Europe"
Date and time the goal was completed.
Example:
"2015-06-19T10:37:04-06:00"
Determines if the goal has been spent.
Example:
false
Determines if the goal is complete.
Example:
false
Additional information a partner can store on the goal.
Example:
"Additional information"
The priority of the goal in relation to multiple goals.
Example:
3
Date and time the goal is to complete. Intended for users to set their own goal completion dates.
Example:
"2026-12-08 00:00:00.000000"
Response
200 - application/json
OK
Hide child attributes
Hide child attributes
Unique identifier of the account for the goal.
Example:
"ACT-4e431124-4a29-abf9-f059-ab232ac14dbf"
Amount of the goal.
Example:
4500
Date and time the goal was completed.
Example:
"2015-06-19T10:37:04-06:00"
The current amount of the goal.
Example:
1651.27
The goal type.
Example:
"PAYOFF"
Unique identifier for the goal. Defined by MX.
Example:
"GOL-f223463-4355-48d0-rce7-fe2rb345617c"
Determines if the goal has been spent.
Example:
false
Determines if the goal is complete.
Example:
false
Additional information a partner can store on the goal.
Example:
"Additional information"
The category of the goal.
Example:
"VACATION"
The name of the goal.
Example:
"Save for Europe"
The priority of the goal in relation to multiple goals.
Example:
3
Date and time the goal is projected to be completed.
Example:
"2022-06-14T16:03:53-00:00"
Date and time the goal is to complete. Intended for users to set their own goal completion dates.
Example:
"2026-12-08 00:00:00.000000"
Example:
"Track Type Name"
The unique identifier for the the user. Defined by MX.
Example:
"USR-11141024-90b3-1bce-cac9-c06ced52ab4c"