Skip to main content
PATCH
/
v0
/
accounts
/
{account_id}
Update Account
curl --request PATCH \
  --url https://api.sumvin.com/v0/accounts/{account_id} \
  --header 'Content-Type: application/json' \
  --header 'x-sumvin-pat: <api-key>' \
  --data '
{
  "nickname": "<string>",
  "is_primary": true
}
'
{
  "_links": {},
  "id": "<string>",
  "provider": "<string>",
  "account_type": "<string>",
  "status": "<string>",
  "institution_name": "<string>",
  "account_name": "<string>",
  "is_primary": true,
  "balance_currency": "<string>",
  "created_at": 123,
  "institution_logo_url": "<string>",
  "account_mask": "<string>",
  "nickname": "<string>",
  "balance_current": "<string>",
  "balance_available": "<string>",
  "balance_updated_at": 123,
  "consent_expires_at": 123,
  "last_synced_at": 123,
  "connection_id": "<string>",
  "verification_status": "<string>",
  "sync_event_id": "<string>"
}

Authorizations

​
x-sumvin-pat
string
header
required

Personal access token issued to the Sumvin CLI. Send it in the x-sumvin-pat header to authenticate as the owning user.

Headers

​
x-juno-orgid
string | null

Tenant org ID for multi-tenant auth

​
x-sumvin-token
string | null
​
x-sumvin-pat
string | null
​
x-juno-jwt
string | null
​
X-Timestamp-Format
string

Controls how timestamp fields are serialized in JSON response bodies.

Default (header omitted or any other value): epoch milliseconds as integers. iso8601: UTC ISO 8601 strings of the form YYYY-MM-DDTHH:MM:SSZ.

Example: with X-Timestamp-Format: iso8601, the field value 1704067200000 becomes "2024-01-01T00:00:00Z".

Affected fields (recursively, in dicts and arrays): any field whose name ends in _at, plus the literal field names timestamp, period_start, and period_end. All other fields are passed through unchanged.

Only iso8601 is recognized. Any other value (or omitting the header) yields the default epoch-ms representation; the server does not reject unknown values, so this is documented as an example rather than an enum to keep generated clients permissive.

Example:

"iso8601"

Path Parameters

​
account_id
string
required

Body

application/json
​
nickname
string | null
Required string length: 1 - 100
​
is_primary
boolean | null

Response

Account nickname updated successfully

​
_links
Links · object
required

HAL-style hypermedia links for navigation and available actions.

​
id
string
required
​
provider
string
required
​
account_type
string
required
​
status
string
required
​
institution_name
string
required
​
account_name
string
required
​
is_primary
boolean
required
​
balance_currency
string
required
​
created_at
integer
required
​
institution_logo_url
string | null
​
account_mask
string | null
​
nickname
string | null
​
balance_current
string | null
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
balance_available
string | null
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
balance_updated_at
integer | null
​
consent_expires_at
integer | null
​
last_synced_at
integer | null
​
connection_id
string | null
​
verification_status
string | null
​
sync_event_id
string | null