Skip to main content
POST
Create a deal

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Body

application/json
lead_uuid
string
required
label
string
required
deal_value
number
default:0
required

Monetary amount in WHOLE currency units (the displayed amount, e.g. 1000.00 = one thousand) — NOT minor units/cents. Do NOT divide or multiply by 100; send and show the amount as-is.

stage_uuid
string
currency_uuid
string
expiration_date
string | null
tag_uuids
string[]
custom_fields
object[]

Response

201 - application/json

Default Response

uuid
string
required
label
string
required
deal_value
number
required

Monetary amount in WHOLE currency units (the displayed amount, e.g. 1000.00 = one thousand) — NOT minor units/cents. Do NOT divide or multiply by 100; send and show the amount as-is.

total_commission_value
number | null
required

Monetary amount in WHOLE currency units (the displayed amount, e.g. 1000.00 = one thousand) — NOT minor units/cents. Do NOT divide or multiply by 100; send and show the amount as-is.

expiration_date
string | null
required
stage
object | null
required
lead
object
required
partner
object | null
required
partners
object[]
required

Every partner on the deal. The primary partner (is_primary: true, the same partner as the deal's partner) comes first, then each supporting (co-sell) partner, oldest first, with its role. Supporting partners appear only while the Co-selling module is enabled, and only while they are active partners of the deal's partner type.

currency
object
required
tags
object[]
required
assigned_users
object[]
required
custom_fields
object[]
required
created_at
string
required
updated_at
string
required