Update an account
Partially updates the account — send only the fields that changed, e.g. {"currentBalance": "192.68"} or {"status": "CLOSED"}. Omitted fields are left unchanged. This is the single endpoint for targeted updates (balance, status, placement, legal, and other mutable fields); identity fields cannot be changed here.
Authorizations
Owner-scoped bearer token. The owner all requests are scoped to is derived from the token.
Path Parameters
Slate's UUID for the account (returned by the upsert). The canonical account identifier.
Body
A partial account update: include only the fields you want to change. Omitted fields are left unchanged. Identity fields (accountId, owner, crid) cannot be changed here.
Account lifecycle status. Binary: ACTIVE (being serviced) or CLOSED (resolved, returned, or otherwise done).
ACTIVE, CLOSED The current amount owed, in US dollars, as a decimal string (e.g. "1250.75").
^-?\d+(\.\d{1,2})?$The charge-off date, if applicable.
The creditor this account belongs to (Slate creditor UUID); must be one your owner manages.
The current client/account number.
Portfolio identifier, if part of a purchased portfolio.
The account's legal activity. A suit and/or a judgment; either may be absent.
Custom key/value pairs you can attach to an object for reporting, analytics, or attributes Slate does not model natively — inspired by Stripe metadata. Values are strings. Limits: at most 50 keys, each key at most 40 characters and each value at most 500 characters. On a partial update (PATCH) the keys you send are merged into the existing metadata; send a key with an empty-string value to remove it. An account upsert (full snapshot) replaces the whole map.
Response
The updated account.
The full account aggregate as Slate holds it.
Slate's stable UUID for the account — the canonical identifier, assigned by Slate on create.
The organization that owns this account in Slate (your owner code).
Your identifier for the account (the account number in your system) — the natural key the upsert matches on, unique within your owner.
The creditor this account belongs to (Slate creditor UUID). Register creditors via POST /v1/creditors; must be one your owner manages.
Account lifecycle status. Binary: ACTIVE (being serviced) or CLOSED (resolved, returned, or otherwise done).
ACTIVE, CLOSED The current amount owed, in US dollars, as a decimal string (e.g. "1250.75").
^-?\d+(\.\d{1,2})?$Current active matter UUID for the account. Currently created on initial account creation, but support will be added later for managing an accounts matters, both current and historical.
The current client/account number. May change over the life of the account (e.g. when paper is sold).
The history of account-number changes for this account, oldest first. Empty when the number has never changed. Read-only — recorded automatically whenever accountNumber changes.
Portfolio identifier, when the account is part of a purchased portfolio. Absent for forwarded/placed paper.
The date the account was closed; null while ACTIVE.
The date the account was charged off, if applicable.
The servicing firm the account is currently placed with, and its fee terms. Null when the account is not placed.
The account's legal activity. A suit and/or a judgment; either may be absent.
When Slate first created the account.
When the account was last updated in Slate.
Custom key/value pairs you can attach to an object for reporting, analytics, or attributes Slate does not model natively — inspired by Stripe metadata. Values are strings. Limits: at most 50 keys, each key at most 40 characters and each value at most 500 characters. On a partial update (PATCH) the keys you send are merged into the existing metadata; send a key with an empty-string value to remove it. An account upsert (full snapshot) replaces the whole map.
