Update user settings

PUT /api/v1/user/settings

Update user settings

cURL

curl --request PUT \
  --url https://api.hevn.finance/api/v1/user/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "appearance": "system",
  "devMode": false,
  "emailsTs": {},
  "notifications": {
    "cashFlow": {
      "email": true,
      "push": true
    },
    "suspiciousActivity": {
      "email": true,
      "push": true
    },
    "tasksAndApprovals": {
      "email": true,
      "push": true
    },
    "yourSpending": {
      "email": true,
      "push": true
    },
    "accountBalances": {
      "email": true,
      "push": true
    },
    "accounting": {
      "email": true,
      "push": true
    },
    "billPay": {
      "email": true,
      "push": true
    },
    "invoicing": {
      "email": true,
      "push": true
    },
    "collaboration": {
      "email": true,
      "push": true
    }
  },
  "bankRequested": {
    "rails": {
      "us": {
        "pooled": false,
        "named": false
      },
      "swift": {
        "pooled": false,
        "named": false
      },
      "eu": {
        "pooled": false,
        "named": false
      },
      "uae": {
        "pooled": false,
        "named": false
      }
    }
  }
}
'

import requests

url = "https://api.hevn.finance/api/v1/user/settings"

payload = {
    "appearance": "system",
    "devMode": False,
    "emailsTs": {},
    "notifications": {
        "cashFlow": {
            "email": True,
            "push": True
        },
        "suspiciousActivity": {
            "email": True,
            "push": True
        },
        "tasksAndApprovals": {
            "email": True,
            "push": True
        },
        "yourSpending": {
            "email": True,
            "push": True
        },
        "accountBalances": {
            "email": True,
            "push": True
        },
        "accounting": {
            "email": True,
            "push": True
        },
        "billPay": {
            "email": True,
            "push": True
        },
        "invoicing": {
            "email": True,
            "push": True
        },
        "collaboration": {
            "email": True,
            "push": True
        }
    },
    "bankRequested": { "rails": {
            "us": {
                "pooled": False,
                "named": False
            },
            "swift": {
                "pooled": False,
                "named": False
            },
            "eu": {
                "pooled": False,
                "named": False
            },
            "uae": {
                "pooled": False,
                "named": False
            }
        } }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    appearance: 'system',
    devMode: false,
    emailsTs: {},
    notifications: {
      cashFlow: {email: true, push: true},
      suspiciousActivity: {email: true, push: true},
      tasksAndApprovals: {email: true, push: true},
      yourSpending: {email: true, push: true},
      accountBalances: {email: true, push: true},
      accounting: {email: true, push: true},
      billPay: {email: true, push: true},
      invoicing: {email: true, push: true},
      collaboration: {email: true, push: true}
    },
    bankRequested: {
      rails: {
        us: {pooled: false, named: false},
        swift: {pooled: false, named: false},
        eu: {pooled: false, named: false},
        uae: {pooled: false, named: false}
      }
    }
  })
};

fetch('https://api.hevn.finance/api/v1/user/settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "appearance": "system",
  "devMode": false,
  "emailsTs": {},
  "notifications": {
    "cashFlow": {
      "email": true,
      "push": true
    },
    "suspiciousActivity": {
      "email": true,
      "push": true
    },
    "tasksAndApprovals": {
      "email": true,
      "push": true
    },
    "yourSpending": {
      "email": true,
      "push": true
    },
    "accountBalances": {
      "email": true,
      "push": true
    },
    "accounting": {
      "email": true,
      "push": true
    },
    "billPay": {
      "email": true,
      "push": true
    },
    "invoicing": {
      "email": true,
      "push": true
    },
    "collaboration": {
      "email": true,
      "push": true
    }
  },
  "bankRequested": {
    "rails": {
      "us": {
        "pooled": false,
        "named": false
      },
      "swift": {
        "pooled": false,
        "named": false
      },
      "eu": {
        "pooled": false,
        "named": false
      },
      "uae": {
        "pooled": false,
        "named": false
      }
    }
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · default: Bearer <token> · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-key · string | null

Body

application/json

User settings.

appearance · enum<string> · default: system

Appearance theme preference.

Available options: system, light, dark

devMode · boolean · default: false

emailsTs · Emailsts · object

Show child attributes

notifications · NotificationsSettings · object

User notification preferences grouped by category.

Categories are UI groupings over NotificationType. Mapping lives in NOTIFICATION_TYPE_CATEGORY. Defaults to all channels enabled.

Show child attributes

bankRequested · BankRequestedSettings · object

User bank-rail interest settings.

Show child attributes

Response

200

application/json

Successful Response

User settings.

appearance · enum<string> · default: system

Appearance theme preference.

Available options: system, light, dark

devMode · boolean · default: false

emailsTs · Emailsts · object

Show child attributes

notifications · NotificationsSettings · object

User notification preferences grouped by category.

Categories are UI groupings over NotificationType. Mapping lives in NOTIFICATION_TYPE_CATEGORY. Defaults to all channels enabled.

Show child attributes

bankRequested · BankRequestedSettings · object

User bank-rail interest settings.

Show child attributes