Skip to main content
POST
/
pipelines
/
{id}
/
stages
Add a stage to a deal pipeline
curl --request POST \
  --url https://api.heffl.com/api/v2/pipelines/{id}/stages \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "position": 123,
  "probability": 123,
  "rottingInDays": 123
}
'
{
  "id": "<string>",
  "name": "<string>",
  "position": 123,
  "probability": 123
}

Authorizations

​
x-api-key
string
header
required

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

Path Parameters

​
id
string
required

Pipeline ID (dpl_ prefix)

Body

application/json
​
name
string
required

Stage name

​
position
number
required

Display order in the pipeline (lower comes first)

​
probability
number

Win probability percentage (0-100). Defaults to 0.

​
rottingInDays
number

Days a deal can sit in this stage before it is flagged as rotting. Defaults to 0 (disabled).

​
type
enum<string>

Stage type. Defaults to ACTIVE. A pipeline must have at least one of each.

Available options:
ACTIVE,
WON,
LOST

Response

OK

​
id
string
required

Pipeline stage ID (dps_ prefix)

​
name
string
required

Stage name

​
position
number
required

Display order in the pipeline

​
probability
number
required

Win probability percentage

​
type
enum<string>
required

Stage type. Moving a deal to a WON or LOST stage updates deal status.

Available options:
ACTIVE,
WON,
LOST