Update a user
PATCH/users/:id
Update a User and/or its associated entities, such as accounts and transactions. When settling a pending transaction on a Performance account, this endpoint can be used to update the affected account(s) balances and update the transaction state atomically in a single request.
Request
Path Parameters
- application/json
Body
required
Partial User, only containing the fields that should be updated. The accounts and transactions arrays are updated using "deep" PATCH semantics and each entity is updated based on the supplied id; The index in the array is unimportant and an empty array will not delete any objects. Only already existing objects can be updated. In order to reconcile a transaction created outside of Impact Finance, create the transaction with a separate call to POST /transactions instead (there is no need to update the account balance atomically in this case).
Array [
- schemas-user.UserSharedSavingsPatchRequest
- user.UserPerformancePatchRequest
]
user
object
accounts
object[]
oneOf
Default value: 0
The total worth of all assets, in cents or the smallest currency subunit.
Default value: 0
The amount of liquid cash available for withdrawal or internal transfer, in cents or the smallest currency subunit.
Default value: 0
The value gained since valuationFrom, in cents or the smallest currency subunit.
Default value: 0
The relative value gained since valuationFrom, in percent.
Default value: 0
The total acquisition cost of the assets on the account, in cents or the smallest currency subunit.
The date time performance indicators are calculated from.
Default value: Time of last update
The date time of market valuation for the assets on the account.
Responses
- 204
- 400
- 404
Request accepted
Bad request
Requested user not found