Sign in

v2

latestOpenAPI 3.1.02026-08-05123191254.3 KB
external-v2-placements

Update Placement

Partially update an existing placement (JSON Merge Patch semantics).

Only the fields present in the request body are updated. An empty body (all fields absent) returns 400 because no meaningful update was requested. Use status="archived" to remove a placement from active views — this mirrors the existing app convention (no row-level delete is supported).

Returns 404 for placements on foreign-account deals or non-existent placements.

patch/api/external/v2/placements/{placement_id}

Path parameters

placement_idinteger required

Request body

status'new' | 'sent' | 'lender_reviewing' | 'terms_received' | 'term_sheet_received' | 'executed_ts_in_closing' | 'closed' | 'unresponsive' | 'willing_to_negotiate' | 'lender_passed' | 'archived'
visibility'hidden' | 'masked' | 'shared'
descriptionstring nullable

Free-text description / per-lender note.

scorenumber nullable

Manual relevance score (0-100).

outreach_datestring date-time nullable

Timestamp the lender was first reached out to (ISO 8601).

lender_status'origination' | 'new' | 'lead_qualification' | 'quotation' | 'negotiation' | 'offer' | 'term_sheet' | 'good_faith_deposit' | 'diligence' | 'in_closing' | 'closed' | 'archived'

Response

Successful Response

request_idstring required
timestampstring required