Skip to main content

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

    id uuidrequired

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).

    user

    object

    givenName string
    familyName string
    provisioningInitiatedAt RFC3339

    accounts

    object[]

  • Array [

  • oneOf

    id uuid
  • ]

  • transactions object[]

Responses

Request accepted

Loading...