Create a deal

POST/deals

Creates a deal in draft and returns it with a Location. min_investment is in major currency units, and currency is a 3-letter code that defaults to USD. Structure-specific details go in type_details, which holds the structure-specific details that the legacy meta field held. Enum-backed values are validated and lower-cased, and an unknown value returns 422; GET /deals/lookups lists the allowed values. dry_run shows the result without saving it. Emits deal.created and sends no email. Publish it with POST /deals/{id}/actions/publish once it is ready to publish. DELETE /deals/{id} undoes it while it is a draft.

Query parameters

dry_runboolean#
Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Headers

Idempotency-Keystring#
Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.

Request body

application/json, required · DealCreate

namestringRequired#
The deal name.
summarystring | null#
The short summary shown on deal cards.
descriptionstring | null#
The deal description, as HTML. It is sanitised on write.
currencystring#
The ISO 4217 currency. Defaults to USD.
min_investmentnumber | null#
The minimum investment, in major currency units.
available_fromstring | null#
When the deal opens to investment.
available_tostring | null#
When the deal closes to investment.
structurestring#
The deal structure: direct, fund or tradeable. Defaults to direct.
One of: direct, fund, tradeable
sub_structurestring#
The deal sub-structure: debt, equity, hybrid, multi_asset, real_assets, real_estate or earthshot_solution. Defaults to equity.
One of: debt, equity, hybrid, multi_asset, real_assets, real_estate, earthshot_solution
type_detailsobject#
The structure-specific details that the legacy meta field held, keyed by field name, such as sector or growthStage. Enum-backed values are validated and lower-cased. GET /deals/lookups lists the allowed values.
sponsorstring | null#
The sponsor name.
show_funding_securedboolean#
Whether investors see how much funding is secured. Defaults to true.
allow_questionsboolean#
Whether investors can ask questions. Defaults to false.
request_further_docsboolean#
Whether investors can request further documents. Defaults to false.

{
  "name": "Series B — Acme Robotics",
  "summary": "Late-stage growth round in autonomous logistics.",
  "currency": "USD",
  "min_investment": 25000,
  "available_from": "2026-07-01T00:00:00+00:00",
  "available_to": "2026-09-30T23:59:59+00:00",
  "structure": "direct",
  "sub_structure": "equity",
  "type_details": {
    "sector": "information_technology",
    "growthStage": "growth"
  },
  "sponsor": "Acme Capital"
}

Responses

201

The deal was created.

Deal

{
  "data": {
    "id": "f6071829-3a4b-4c5d-9e6f-8091a2b3c4d5",
    "name": "Series B — Acme Robotics",
    "status": "published",
    "external": false,
    "external_id": "CRM-2026-0042",
    "summary": "Late-stage growth round in autonomous logistics.",
    "description": "<p>Acme Robotics is raising a Series B.</p>",
    "currency": "USD",
    "min_investment": 25000,
    "structure": "direct",
    "sub_structure": "equity",
    "type_details": {
      "sector": "information_technology",
      "growthStage": "growth"
    },
    "sponsor": "Acme Capital",
    "show_funding_secured": true,
    "allow_questions": false,
    "request_further_docs": false,
    "available_from": "2026-07-01T00:00:00+00:00",
    "available_to": "2026-09-30T23:59:59+00:00",
    "transaction_workflow_id": "1b2c3d4e-5f60-4a7b-8c9d-0e1f2a3b4c5d",
    "investor_engagement_enabled": true,
    "active_tranche_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
    "drafted_at": "2026-06-15T10:30:00+00:00",
    "approval_started_at": "2026-06-16T09:00:00+00:00",
    "approved_at": "2026-06-17T09:00:00+00:00",
    "published_at": "2026-06-18T09:00:00+00:00",
    "rejected_at": null,
    "retired_at": null,
    "tabs": [
      "deal",
      "documents",
      "video"
    ],
    "image_id": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
    "sponsor_image_id": null,
    "video_id": "76979871",
    "custom_status_id": null,
    "created_at": "2026-06-15T10:30:00+00:00",
    "updated_at": "2026-06-18T09:00:00+00:00"
  }
}

401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error

403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error

422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error

429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X POST https://your-org-domain/kong/core/api/v2/deals\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "name": "Series B — Acme Robotics",
  "summary": "Late-stage growth round in autonomous logistics.",
  "currency": "USD",
  "min_investment": 25000,
  "available_from": "2026-07-01T00:00:00+00:00",
  "available_to": "2026-09-30T23:59:59+00:00",
  "structure": "direct",
  "sub_structure": "equity",
  "type_details": {
    "sector": "information_technology",
    "growthStage": "growth"
  },
  "sponsor": "Acme Capital"
}'