Reference Data

Add a stage to a deal pipeline

Adds a new stage to an existing pipeline. Returns the created stage with its ID (dps_).

post/pipelines/{id}/stages

Request

  • Base URL: https://api.heffl.com/api/v2
  • URL: https://api.heffl.com/api/v2/pipelines/{id}/stages
  • Auth: API key in header x-api-key

Path parameters

idstring required

Pipeline ID (dpl_ prefix)

Request body

namestring required

Stage name

positionnumber required

Display order in the pipeline (lower comes first)

probabilitynumber

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

rottingInDaysnumber

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

type'ACTIVE' | 'WON' | 'LOST'

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

Response

OK

idstring required

Pipeline stage ID (dps_ prefix)

namestring required

Stage name

positionnumber required

Display order in the pipeline

probabilitynumber required

Win probability percentage

type'ACTIVE' | 'WON' | 'LOST' required

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

Changes

No recorded changes to this operation across all 1 revision of this API.