Skip to main content
PATCH
Update a deal

Authorizations

x-api-key
string
header
required

API key for authentication. Get yours at app.heffl.com/settings/developers

Path Parameters

id
string
required

Deal public ID

Body

application/json
title
string

Deal title

price
number

Deal value/price

stageId
string

Pipeline stage public ID

status
enum<string>

Deal status (ACTIVE, WON, LOST)

Available options:
ACTIVE,
WON,
LOST
priority
enum<string>

Deal priority

Available options:
LOW,
MEDIUM,
HIGH
sourceId
string

Deal source public ID

expectedCloseDate
string<date-time>

Expected close date

{key}
any

Response

200 - application/json

OK

id
string
required

Deal public ID

title
string
required

Deal title

createdAt
string<date-time>
required

When the deal was created

number
string | null

Auto-generated deal number

price
number | null

Deal price/value

status
string | null

Deal status

priority
string | null

Deal priority

expectedCloseDate
string<date-time> | null

Expected close date

clientId
string | null

Client public ID

pipelineId
string | null

Pipeline public ID

stageId
string | null

Pipeline stage public ID

sourceId
string | null

Deal source public ID

leadId
string | null

Lead public ID

customFields
object | null

Custom field values