Skip to main content
POST
/
pipelines
Create a deal pipeline
curl --request POST \
  --url https://api.heffl.com/api/v2/pipelines \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "stages": [
    {
      "name": "<string>",
      "position": 123,
      "probability": 123,
      "rottingInDays": 123
    }
  ],
  "icon": "<string>",
  "isActive": true
}
'
{
  "id": "<string>",
  "name": "<string>",
  "stages": [
    {
      "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

Body

application/json
name
string
required

Pipeline name

stages
object[]
required

Stages for the pipeline. Must include at least one ACTIVE, one WON, and one LOST stage.

icon
string

Tabler icon name for the pipeline. Defaults to an icon.

isActive
boolean

Whether the pipeline is active. Defaults to true.

Response

OK

id
string
required

Pipeline ID (dpl_ prefix)

name
string
required

Pipeline name

stages
object[]
required