Skip to main content
PUT
/
api
/
deals
/
{deal_id}
Update a deal
curl --request PUT \
  --url https://api.morphic.io/api/deals/{deal_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "stage": "<string>",
  "status": "<string>",
  "amount": 123,
  "currency": "<string>",
  "probability": 50,
  "expected_close_date": "2023-12-25",
  "source": "<string>",
  "competing_options": [
    "<string>"
  ],
  "next_step": "<string>",
  "tags": [
    "<string>"
  ],
  "notes": "<string>",
  "categories": [
    "<string>"
  ],
  "contact_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "assigned_to_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "closed_at": "2023-11-07T05:31:56Z",
  "lost_reason": "<string>",
  "metadata": {},
  "enrichment": {},
  "enrichment_provider": "<string>",
  "enrichment_last_updated": "2023-11-07T05:31:56Z",
  "enrichment_status": "<string>",
  "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "custom_fields": {}
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "stage": "<string>",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "status": "open",
  "amount": "<string>",
  "currency": "USD",
  "probability": 50,
  "expected_close_date": "2023-12-25",
  "source": "<string>",
  "competing_options": [
    "<string>"
  ],
  "next_step": "<string>",
  "tags": [
    "<string>"
  ],
  "notes": "<string>",
  "categories": [
    "<string>"
  ],
  "contact_ids": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    }
  ],
  "assigned_to_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "closed_at": "2023-11-07T05:31:56Z",
  "lost_reason": "<string>",
  "metadata": {},
  "enrichment": {},
  "enrichment_provider": "<string>",
  "enrichment_last_updated": "2023-11-07T05:31:56Z",
  "enrichment_status": "<string>",
  "company_id": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "custom_fields": {},
  "is_favorite": false
}

Authorizations

​
X-API-Key
string
header
required

API key (sk_xxx) from Developer Settings. No X-Account-ID needed.

Headers

​
x-account-id
string | null

Path Parameters

​
deal_id
string<uuid>
required

Body

application/json
​
name
string | null
Required string length: 1 - 255
​
description
string | null
​
stage
string | null
​
status
string | null
​
amount
​
currency
string | null
Maximum string length: 3
​
probability
integer | null
Required range: 0 <= x <= 100
​
expected_close_date
string<date> | null
​
source
string | null
​
competing_options
string[] | null
​
next_step
string | null
​
tags
string[] | null
​
notes
string | null
​
categories
string[] | null
​
contact_ids
string<uuid>[] | null
​
assigned_to_id
string<uuid> | null
​
closed_at
string<date-time> | null
​
lost_reason
string | null
​
metadata
Metadata · object
​
enrichment
Enrichment · object
​
enrichment_provider
string | null
​
enrichment_last_updated
string<date-time> | null
​
enrichment_status
string | null
​
company_id
string<uuid> | null
​
custom_fields
Custom Fields · object

Response

Successful Response

​
id
string<uuid>
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
name
string
required
Required string length: 1 - 255
​
stage
string
required

Pipeline stage (e.g., qualification, negotiation, closed_won)

​
account_id
string<uuid>
required
​
description
string | null
​
status
string
default:open

Deal status (open, won, lost)

​
amount
string | null
​
currency
string
default:USD
Maximum string length: 3
​
probability
integer | null
Required range: 0 <= x <= 100
​
expected_close_date
string<date> | null
​
source
string | null
​
competing_options
string[] | null
​
next_step
string | null
​
tags
string[] | null
​
notes
string | null
​
categories
string[] | null
​
contact_ids
ReferenceItem · object[] | null

Associated contacts with id and name

​
assigned_to_id
string<uuid> | null
​
closed_at
string<date-time> | null
​
lost_reason
string | null
​
metadata
Metadata · object
​
enrichment
Enrichment · object
​
enrichment_provider
string | null
​
enrichment_last_updated
string<date-time> | null
​
enrichment_status
string | null
​
company_id
ReferenceItem · object

Company with id and name

​
custom_fields
Custom Fields · object
​
is_favorite
boolean
default:false

Whether this record is favorited by the current user