Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
title
string
Minimum string length: 1
company
string | null
contactId
string<uuid> | null
value
number | null
currency
string
stage
string
Required string length: 1 - 200
pipelineId
string<uuid> | null
probability
number | null
status
enum<string>
Available options:
open,
won,
lost
priority
enum<string>
Available options:
low,
medium,
high
assigneeId
string<uuid> | null
expectedCloseDate
string | null
notes
string | null
lostReason
string | null
closedAt
string
source
string | null
Maximum string length: 200
partnerClientId
string<uuid> | null
commissionPctOverride
number | null
Required range: 0 <= x <= 100
expectedVersion
integer | null
archivedAt
string | null
customFields
object

Response

200 - application/json

Success

data
object
required