Skip to main content
POST
Create a deal

Authorizations

x-metal-client-id
string
header
default:<client-id>
required

The Client ID of your API key.

x-metal-api-key
string
header
default:<api-key>
required

The secret value of your API key.

Body

application/json
name
string
required
Example:

"Project Atlas"

companyId
string

The target company's id.

status
enum<string>
Available options:
ACTIVE,
CLOSED,
PASSED_DEAD
stage
enum<string>
Available options:
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

A deal.

data
object