v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB

Sales::Pipelines::Stage

Create Stage

post/sales/pipelines/{pipeline_id}/stages

Path parameters

pipeline_idinteger required

Request body

Example request

{
  "sales_pipelines_stage": {
    "sales_pipelines_stage": {
      "name": "Example Stage",
      "sort_order": 5,
      "close_probability": 20
    }
  }
}

Response

Created

idinteger

Stage ID

public_idstring nullable

Stage public ID

workspace_idinteger nullable

Workspace ID

pipeline_idinteger

Pipeline ID

namestring

Stage name

sort_orderinteger nullable

The position of the stage in the pipeline. The stages are ordered by the sort order attribute, starting at zero. If not provided, the stage will be added at the end of the pipeline. If provided, the stage will be inserted at the specified position, and the sort order of the subsequent stages will be incremented by one.

close_probabilitynumber

Close probability of the opportunities in this stage

{"stackTrail":"components:schemas:SalesPipelinesStageAttributes:properties:opportunity_ids","oasType":"schema","type":"unknown","description":"Opportunity IDs of all opportunities currently belonging to this stage"}

created_atstring date-time nullable

Created at

updated_atstring date-time nullable

Updated at

total_valueinteger nullable

Total value of all opportunities in this stage

weighted_valuenumber nullable

A calculation of the weighted value of all opportunities in this stage

Example response

{
  "id": 39,
  "public_id": "bGXvFU",
  "workspace_id": 3,
  "pipeline_id": 2,
  "name": "Example Stage",
  "sort_order": 5,
  "close_probability": 20,
  "opportunity_ids": [
    9,
    10
  ],
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z",
  "total_value": 0,
  "weighted_value": 0
}