Skip to main content
PUT
/
v1
/
deals
/
{id}
Update a deal
curl --request PUT \
  --url https://api.metal.ai/v1/deals/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-metal-api-key: <api-key>' \
  --header 'x-metal-client-id: <api-key>' \
  --data '
{
  "name": "<string>",
  "companyId": "<string>",
  "sector": "<string>",
  "size": 123,
  "notes": "<string>"
}
'
{
  "data": {
    "id": "665f1c2a9b1e4a0012a3b4c5",
    "name": "Project Atlas",
    "companyId": "<string>",
    "status": "ACTIVE",
    "stage": "DUE_DILIGENCE",
    "externalStatus": "<string>",
    "externalStage": "<string>",
    "owners": [
      {
        "id": "<string>",
        "type": "<string>"
      }
    ],
    "sector": "<string>",
    "industry": "<string>",
    "size": 123,
    "notes": "<string>",
    "externalReference": {
      "source": "<string>",
      "id": "<string>"
    }
  }
}

Authorizations

x-metal-client-id
string
header
required

The Client ID of your API key.

x-metal-api-key
string
header
required

The secret value of your API key.

Path Parameters

id
string
required

The deal id.

Body

application/json

Fields to update on a deal.

name
string
companyId
string
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
size
number
notes
string

Response

A deal.

data
object