v3

latestOpenAPI 3.1.02026-08-08123192255.1 KB

external-v2-deals

Create Deal

Create a new deal.

body: CreateDealRequest lets FastAPI/Pydantic parse and validate the request body automatically. Missing title or constraint violations return 422 before reaching this function.

post/api/external/v2/deals

Request body

titlestring required

Deal title (required)

loan_amountnumber nullable

Requested loan amount

priority'No priority' | 'Urgent' | 'High' | 'Medium' | 'Low'

transaction_type'TBD' | 'Acquisition' | 'Refinance' | 'New Construction'

business_plan'stabilized' | 'value_add' | 'construction' | 'land'

descriptionstring nullable

Free-text deal description

estimated_close_datestring date nullable

Estimated close date (ISO 8601 date string, e.g. 2025-12-31)

pipeline_idsinteger[] nullable

Pipeline IDs to associate with the deal (max 25). All ids must belong to the caller's account; unknown or cross-account ids return 404. Financing and acquisition pipelines may each appear at most once.

sponsor_private_company_idinteger nullable

ID of the sponsor company (a PrivateCompany) to link to this deal. Must belong to the caller's account. Linking also adds the sponsor's users to the deal team when the deal is brokered.

Response

Successful Response

request_idstring required

timestampstring required