---
title: "Create a deal"
method: POST
path: "/v1/deals"
tags: ["Deals"]
---

# Create a deal

`POST /v1/deals`

Creates a deal. Provide a `name` and, typically, the target `companyId`.

## Request body

- DealCreate
  - `name` string, required
  - `companyId` string — The target company's id.
  - `status` 'ACTIVE' | 'CLOSED' | 'PASSED_DEAD'
  - `stage` 'SOURCED' | 'SCREENED' | 'IOI_TERM_SHEET' | 'DUE_DILIGENCE' | 'IC_MEETING' | 'DEAL_CLOSING' | 'PORTFOLIO_COMPANY' | 'REALIZED' | 'PASSED' | 'DEAD'
  - `sector` string
  - `industry` string
  - `size` number
  - `notes` string
  - `externalId` string

## Response `201`

A deal.

- object
  - `data` Deal
    - `id` string
    - `name` string
    - `companyId` string — The target company's id.
    - `status` 'ACTIVE' | 'CLOSED' | 'PASSED_DEAD' — Internal lifecycle status.
    - `stage` 'SOURCED' | 'SCREENED' | 'IOI_TERM_SHEET' | 'DUE_DILIGENCE' | 'IC_MEETING' | 'DEAL_CLOSING' | 'PORTFOLIO_COMPANY' | 'REALIZED' | 'PASSED' | 'DEAD' — Pipeline stage.
    - `externalStatus` string — Your firm's custom status label, when configured.
    - `externalStage` string — Your firm's custom stage label, when configured.
    - `acquisitionType` 'add_on' | 'platform' — Derived, read-only classification of the deal. `add_on` if the deal has a platform company (an add-on acquisition under an existing portfolio company), otherwise `platform`. Computed on read from the deal's platform company; cannot be set via create, update, or any other write endpoint.
    - `owners` Reference[]
      - `id` string
      - `type` string — The referenced resource type, e.g. "user" or "team".
    - `sector` string
    - `industry` string
    - `size` number
    - `notes` string
    - `externalReference` ExternalReference — A structured reference to a record in an external source system.
      - `source` string — The external system, e.g. a CRM provider.
      - `id` string — The record id in the external system.

## Other responses

- `400` — The request body or parameters are invalid.
- `401` — Missing or invalid API key credentials.

---

[API](https://skmtc.net/metal/apis/metal-api.md) · [All operations](https://skmtc.net/metal/apis/metal-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/metal/metal-api/revisions/afb7b675d5b2/schema)