Skip to main content
POST
Create deal

Authorizations

Authorization
string
header
required

Authorization: Bearer tlv_…

Headers

Idempotency-Key
string

Optional. A unique value (e.g. a UUID) per operation, up to 255 characters. Retrying with the same key and body returns the first response instead of doing it again. Kept 24 hours.

Example:

"5f1c2b0e-8d6a-4c1f-9a43-2b7e0f6d1a90"

Body

application/json
name
string
required

Deal name.

pipelineId
string<uuid>
required

Pipeline.

stage
string
required

A stage ID from that pipeline.

value
number

Amount.

currency
string

Default KES.

probability
integer

0–100.

expectedCloseDate
string<date>

Expected close.

companyId
string<uuid>

Company.

contactId
string<uuid>

Main contact.

description
string

Notes.

Response

Success