Skip to main content
PATCH
/
pipelines
/
{id}
Update a deal pipeline
curl --request PATCH \
  --url https://api.heffl.com/api/v2/pipelines/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "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

Path Parameters

id
string
required

Pipeline ID (dpl_ prefix)

Body

application/json
name
string

Pipeline name

icon
string

Tabler icon name for the pipeline

isActive
boolean

Whether the pipeline is active

Response

OK

id
string
required

Pipeline ID (dpl_ prefix)

name
string
required

Pipeline name

stages
object[]
required