Update Savings Goal

The PATCH goals/v1/savings/{goal_id} endpoint is used to update a savings goal.

The goal's name, target_amount, target_date, and recurrent_amount can be updated.

If target_amount, target_date, and/or recurrent_amount is updated, then another of the fields must be supplied as is the case with the POST goals/v1/savings endpoint. Validation upon these fields is re-run when the goal is updated as it is on the POST goals/v1/savings endpoint.

This endpoint will return the updated savings goal. An example of a 200 response can be seen below.

{
  "operation_id": "goals_v1_savings_post",
  "data": {
    "id": "f46d76c4-56d3-11ee-ac69-d6df71eb5902",
    "account_id": "RxsYshVGded4JeilkXgWKdXA",
    "name": "Holiday",
    "target_amount": {
      "currency": "GBP",
      "value": "3000.00"
    },
    "recurrent_amount": {
      "currency": "GBP",
      "value": "750.00"
    },
    "target_date": "2024-01-30",
    "saved_amount": {
      "currency": "GBP",
      "value": "0.00"
    },
    "created_at": "2023-09-19T10:04:43Z"
  }
}

curl --request PATCH \
     --url https://api-sandbox.thisisbud.com/goals/v1/savings/goal_id \
     --header 'X-Client-Id: ecfa9b53-963b-4f8a-9811-e09a79ff7019' \
     --header 'X-Customer-Id: 2a7a1f1c-18b9-4af1-8424-91c5848e8037' \
     --header 'X-Customer-Secret: 2efbed02ac697a80354e0a792bbe733aed904820d030321a0b50b51c1dd05bd3' \
     --header 'accept: application/json' \
     --header 'authorization: Bearer dddd' \
     --header 'content-type: application/json' \
     --data '{"name":"Holiday"}'

In the case that the provided goal_id does not exist, 404 HTTP response will be given

If you receive a 400 response, please check the headers and body you're sending in the request before trying again.

If you receive a 401 response from either of the endpoints this would indicate that you are not authorised to make this request, if you believe this to be a mistake or are receiving persistent 500 responses please raise a support request.

If you have any questions, please contact us via the chatbot (bottom-right of screen 👉) or via a support request or check our FAQs.