Sign in

v2

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

Create Placement

Create a new placement (lender outreach) on a deal.

Required body fields: deal_id and private_company_id. Both must belong to the caller's account; cross-account or non-existent IDs return 404. AI lender-contact matching is disabled for this endpoint (match_contact_with_ai=False) — placements created via the external API are explicit and deterministic.

post/api/external/v2/placements

Request body

deal_idinteger required

ID of the deal this placement belongs to (required).

private_company_idinteger required

ID of the lender company (a PrivateCompany) being placed against this deal. Must belong to the caller's account (use list_companies to find candidates).

contact_idinteger nullable

Optional ID of the lender contact (a Contact in the caller's account) for this outreach.

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. This is the canonical location for lender-specific feedback on the deal (e.g. '08/11 soft quote received…').

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