banking.v1.AllocationsService

UpdateAllocation

Update the presentation fields of an existing allocation (AllocationManage). Never changes state or identity.

post/banking.v1.AllocationsService/UpdateAllocation

Request

  • The document declares no server URL.
  • Auth: none required

Headers

Connect-Protocol-Version1 required

Define the version of the Connect protocol

Connect-Timeout-Msnumber

Define the timeout, in ms

Request body

servicestring
titlestring
summarystring
iconstring nullable

See Allocation.icon. optional — and it is the ONLY field here that is, because it is the only one where "the caller did not mention it" has to be distinguishable from "the caller cleared it". Unset means LEAVE THE STORED ICON ALONE; empty string means reset to fund; an unknown value is refused.

Without presence a scalar string cannot tell those apart, and every caller built before this field existed — a consumer repo on an older contracts pin, a browser tab holding a stale bundle, a pod mid-rolling-deploy — would silently wipe the operator's pick on the next title edit. title and summary need no such escape: they predate every live caller, so an omitted title is a client bug the boundary refuses outright rather than a field it has to guess about.

Response

Success

servicestring

the slug — the id used by every FundsService RPC

titlestring

display name ("EV Trading")

summarystring

one-line description for the catalog card

statestring

draft | open | closed

unit_capstring

authorised unit supply, decimal (default 100000000)

iconstring

Catalog glyph the client maps onto one of its SVGs. Presentation only. One of: fund | real_estate | trading | yield | venture | treasury | commodity | credit | index | arbitrage. Always populated on a response — fund is the default.

accessstring

The product's default access level: hidden | view | invest. What an investor with no grant holds. A registration lands on view.

caller_accessstring

The level the CALLER effectively holds — the higher of access and the caller's own grant, if any. Populated honestly for everyone, an AllocationManage holder included: their permission lets them read and administer the product, it does not make them an investor in it, so a manager's caller_access says what they would get as one. A client renders the card off access and the subscribe control off this — never off state alone.

backingstring

What stands behind the units: cash | in_kind. cash — the units were paid for into the fund's claim and a redemption pays out of it. in_kind — the units stand for an asset the holders own; the fund holds no cash for them, so Redeem is refused (FAILED_PRECONDITION) and holders exit through the book. Set to in_kind automatically by the first IssueUnits on the product; only SetAllocationBacking takes it back to cash. A registration lands on cash.

Changes

No recorded changes to this operation across all 1 revision of this API.