Skip to main content
PATCH
cURL

Authorizations

X-Api-Key
string
header
required

Path Parameters

organization_uuid
string<uuid>
required
uuid
string<uuid>
required

Body

The client PATCH accepts client fields and legacy single-account updates.

external_id
string
tax_account_type
enum<string>
  • unknown - Unknown
  • taxable - Taxable
  • traditional_ira - Traditional IRA
  • roth_ira - Roth IRA
  • sep_ira - SEP IRA
  • simple_ira - SIMPLE IRA
  • inherited_ira - Inherited IRA
  • 401k - 401(k)
  • roth_401k - Roth 401(k)
  • 403b - 403(b)
  • roth_403b - Roth 403(b)
  • 457b - 457(b)
  • hsa - HSA
  • 529 - 529 plan
  • rrsp - RRSP
  • rrif - RRIF
  • tfsa - TFSA
  • fhsa - FHSA
  • resp - RESP
  • rdsp - RDSP
  • lira - LIRA
Available options:
unknown,
taxable,
traditional_ira,
roth_ira,
sep_ira,
simple_ira,
inherited_ira,
401k,
roth_401k,
403b,
roth_403b,
457b,
hsa,
529,
rrsp,
rrif,
tfsa,
fhsa,
resp,
rdsp,
lira
holdings
object

Serializer for updating holdings data.

metadata
any | null

Store arbitrary metadata about this account in a JSON field, but should not include PII information.

customization_config
object
portfolio_config_uuid
string<uuid> | null
write-only
portfolio_allocations
object[] | null
write-only
asset_class_settings
object[]
sleeve_path_overrides
object[]

Replaces the account's whole set of customizations of sleeves inside composites.

sleeve_holdings_caps
object[]

Replaces the account's whole set of its own holdings caps; a place with no row follows the model.

reporting_benchmark
object | null
cross_account_optimization_enabled
boolean
status
enum<string>

Set client when a prospect joins the firm. A client can't be made a prospect.

  • client - Client
  • prospect - Prospect
Available options:
client,
prospect

Response

200 - application/json
uuid
string<uuid>
required
read-only
external_id
string
required

External identifier for the client

Maximum string length: 50
created
string<date-time>
required
read-only
modified
string<date-time>
required
read-only
accounts
object[]
required
read-only
household
object | null
required

Read-only nested serializer for household in client responses.

status
enum<string>
required

Whether the firm manages this client's money yet, or is modeling them as a prospect.

  • client - Client
  • prospect - Prospect
Available options:
client,
prospect
cross_account_optimization
object
required
holdings_risk_annualized_percentage
string<decimal> | null
required
read-only
Pattern: ^-?\d{0,2}(?:\.\d{0,10})?$
holdings_risk_model
object | null
required

The risk model behind holdings_risk_annualized_percentage: the organization's setting.

holdings_standard_deviation
object | null
required

Historical standard deviation of the current holdings, held at today's weights.

metadata
any | null

Store arbitrary metadata about this client in a JSON field, but should not include PII information.

cross_account_optimization_enabled
boolean