Vault Origination

Update an origination opportunity (curator: admin)

Partial update — only supplied fields change. An explicit null clears a nullable field. Requires an admin role on the vault's curator org.

put/v3/vaults/{vaultId}/origination/opportunities/{opportunityId}

Request

  • Base URL: https://api.creditcoop.xyz
  • URL: https://api.creditcoop.xyz/v3/vaults/{vaultId}/origination/opportunities/{opportunityId}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://clerk.creditcoop.xyz/oauth/authorize, token URL https://clerk.creditcoop.xyz/oauth/token)

Path parameters

vaultIdstring uuid required
opportunityIdstring uuid required

Request body

state'diligence' | 'term_sheet' | 'committed' | 'funded' | 'declined' | 'withdrawn'
borrowerTypestring

Counterparty descriptor, e.g. 'Card issuer'

expectedSizestring nullable

Smallest-unit non-negative integer string, max 78 digits (numeric(78,0)); omit when unscoped

expectedYieldBpsinteger nullable

Expected all-in yield in basis points (1250 = 12.50%)

conversionBpsinteger nullable

Close probability in basis points; null means unscored and contributes 0 to the probability-weighted total

outcomeReasonstring nullable

Why a terminal deal ended, e.g. 'Pricing misalignment'

targetFundingBystring date-time nullable

Machine-comparable target funding date, summed for the funding-by tile

targetFundingLabelstring nullable

Display window, e.g. 'Sep 8 – 15', 'Q4 2026'

geostring nullable
sectorstring nullable
labelstring

Curator pseudonym shown to depositors, e.g. 'J'. Unique per vault.

sortOrderinteger

Board ordering within a stage column

Response

Default Response

idstring uuid required
vaultAddressstring required
networkIdstring required
state'diligence' | 'term_sheet' | 'committed' | 'funded' | 'declined' | 'withdrawn' required
borrowerTypestring required
expectedSizestring nullable

Smallest-unit non-negative integer string

expectedYieldBpsinteger nullable
conversionBpsinteger nullable
outcomeReasonstring nullable
targetFundingBystring date-time nullable
targetFundingLabelstring nullable
geostring nullable
sectorstring nullable
labelstring required
sortOrderinteger required
createdAtstring date-time required
updatedAtstring date-time required

Changes

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