Skip to main content
POST
PublicApiCreateDeal
Use this endpoint through the Developer API or the matching firstsales CLI command when available. Responses use the stable FirstSales public error envelope.

Authorizations

Authorization
string
header
required

Legacy compatibility bearer scheme for generated consumers.

Path Parameters

orgId
string
required
wsId
string
required

Body

application/json
contactId
string
required
Pattern: ^[0-9a-fA-F]{24}$
value
number
required
Required range: x >= 0
currency
string
default:USD
required
Required string length: 1 - 10
pipelineId
string
required
Pattern: ^[0-9a-fA-F]{24}$
ownerId
string
required
Minimum string length: 1
companyId
string
Pattern: ^[0-9a-fA-F]{24}$
stageId
string
Pattern: ^[0-9a-fA-F]{24}$
expectedClose
string<date-time>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
labels
string[]
Maximum array length: 20
Required string length: 1 - 50

Response

Successful response

The response is of type object.