Sign in
Savings Goals

Create a savings goal

put/api/v2/account/{accountUid}/savings-goals

Path parameters

accountUidstring uuid required
Example:aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa

Account uid

Request body

namestring required

Name of the savings goal

currencystring required

ISO-4217 3 character currency code of the savings goal

base64EncodedPhotostring

A text (base 64) encoded picture to associate with the savings goal

Example request

{
  "name": "Trip to Paris",
  "currency": "GBP",
  "target": {
    "currency": "GBP",
    "minorUnits": 123456
  }
}

Response

Successful operation

savingsGoalUidstring uuid

Unique identifier of the savings goal

successboolean

True if the method completed successfully

Example response

{
  "savingsGoalUid": "77887788-7788-7788-7788-778877887788",
  "success": true
}