Skip to main content
PUT
Update a deal

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 | null
enrichment
Enrichment · object | null
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 | null

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 | null

Company with id and name

custom_fields
Custom Fields · object | null
is_favorite
boolean
default:false

Whether this record is favorited by the current user