Skip to main content
POST
/
deals
Create a new deal
curl --request POST \
  --url https://api.heffl.com/api/v1/deals \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "title": "<string>",
  "pipelineId": "<string>",
  "stageId": "<string>",
  "clientId": "<string>",
  "leadId": "<string>",
  "sourceId": "<string>",
  "price": 123,
  "expectedCloseDate": "2023-11-07T05:31:56Z",
  "priority": "LOW"
}
'
{
  "id": "<string>",
  "title": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "number": "<string>",
  "price": 123,
  "status": "<string>",
  "priority": "<string>",
  "expectedCloseDate": "2023-11-07T05:31:56Z",
  "clientId": "<string>",
  "pipelineId": "<string>",
  "stageId": "<string>",
  "sourceId": "<string>",
  "leadId": "<string>",
  "customFields": {}
}

Authorizations

x-api-key
string
header
required

API key for authentication. Get yours at app.heffl.com/settings/developers

Body

application/json
title
string
required

Deal title

Minimum string length: 1
pipelineId
string
required

Pipeline public ID

stageId
string
required

Pipeline stage public ID

clientId
string
required

Client public ID (required)

leadId
string

Lead public ID

sourceId
string

Deal source public ID

price
number

Deal value/price

expectedCloseDate
string<date-time>

Expected close date

priority
enum<string>

Deal priority

Available options:
LOW,
MEDIUM,
HIGH
{key}
any

Response

200 - application/json

OK

id
string
required

Deal public ID

title
string
required

Deal title

createdAt
string<date-time>
required

When the deal was created

number
string | null

Auto-generated deal number

price
number | null

Deal price/value

status
string | null

Deal status

priority
string | null

Deal priority

expectedCloseDate
string<date-time> | null

Expected close date

clientId
string | null

Client public ID

pipelineId
string | null

Pipeline public ID

stageId
string | null

Pipeline stage public ID

sourceId
string | null

Deal source public ID

leadId
string | null

Lead public ID

customFields
object

Custom field values