Skip to main content
PATCH
Update a deal

Authorizations

Authorization
string
header
required

OAuth 2.1 access token.

Path Parameters

id
string<uuid>
required

UUID of the resource.

Body

application/json
name
string
Maximum string length: 70
pipeline_id
string<uuid>
stage_id
string<uuid>
currency
enum<string>

ISO 4217 currency code supported by Vendaze.

Available options:
AED,
ARS,
AUD,
BRL,
CAD,
CHF,
CLP,
CNY,
COP,
DKK,
EGP,
EUR,
GBP,
HKD,
ILS,
INR,
JPY,
KWD,
MAD,
MXN,
MYR,
NGN,
NOK,
NZD,
PEN,
QAR,
SAR,
SEK,
SGD,
TRY,
USD,
UYU,
ZAR
Example:

"USD"

price_cts
integer

Deal value in cents.

Required range: x >= 0
owner_email
string<email> | null

Email of the workspace member to set as owner.

Example:

"joao@company.com"

forecast_date
string<date-time> | null
person_ids
string<uuid>[]
company_ids
string<uuid>[]
tags
string[]

Tag keys to associate with the deal.

Required string length: 1 - 30
custom_fields
object[]

Custom field values to set for the deal.

products
object[]
association_mode
enum<string>
default:append
Available options:
append,
replace

Response

Deal updated successfully.

data
object