Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

Bearer token: a Platform API Key (format: ak_live::) or a Personal Access Token (format: rgo-...). PATs always act as the token owner.

Path Parameters

id
string
required

Body

application/json
name
string
Maximum string length: 255
value
number
currency
string
Maximum string length: 10
expectedCloseDate
string | null
notes
string
Maximum string length: 10000
crmCompanyId
string | null
contactId
string | null
stageId
string
ownerId
string | null

null clears the account owner, leaving the deal unassigned.

customFields
object

Response

id
string
required
name
string
required
pipelineId
string
required
stageId
string
required
companyId
string
required
enteredStageAt
string<date-time>
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
value
number
currency
string
expectedCloseDate
string<date-time>
notes
string
crmCompanyId
string
contactId
string
ownerId
string | null
lostReason
string

Configurable per company, so a key rather than a fixed enum value.

lostReasonNote
string
wonAt
string<date-time>
lostAt
string<date-time>
customFields
object
crmCompany
object
contact
object
stage
object
contacts
object[]
owner
object
isRotting
boolean
signal
object

Server-computed health signals from crm_deal_signal.

Present once the signal sweep has seen the deal. The board must render signal.healthBand rather than guessing from timestamps on the client, so the badge, the workflow rules and Mira all agree on one answer.