Skip to main content
POST
Create a partnership deal

Authorizations

Authorization
string
header
required

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

Path Parameters

partnershipId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
lead_id
string
required
deal_label
string

Rejected with 400 (hidden_by_rule) when the vendor hides the deal name; the deal name is then derived from the lead's company name.

stage_uuid
string
tags
string[]
customFields
object[]
expiration_days
number
deal_value
number
products
object[]
notes
object[]
currency_code
string
Maximum string length: 10
quote
object

Response

Default Response

id
string
required
uuid
string
required
quote_uuid
string