Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
Sales::Pipeline

Create Pipeline

Create Pipeline

post/workspaces/{workspace_id}/sales/pipelines

Path parameters

workspace_idinteger required

Request body

Example request

{
  "sales_pipeline": {
    "sales_pipeline": {
      "name": "Example Pipeline"
    }
  }
}

Response

Created

idinteger

Pipeline ID

public_idstring nullable

Pipeline public ID

workspace_idinteger

Workspace ID

namestring

Pipeline name

created_atstring date-time nullable

Created at

updated_atstring date-time nullable

Updated at

total_valueinteger nullable

Total value of the opportunities

Example response

{
  "id": 1,
  "public_id": "LbCUlW",
  "workspace_id": 42000,
  "name": "Example Pipeline",
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z",
  "total_value": 0,
  "stages": [
    {
      "id": 35,
      "public_id": "LNKqFC",
      "workspace_id": 2,
      "pipeline_id": 1,
      "name": "Example Stage",
      "sort_order": 1,
      "close_probability": 20,
      "opportunity_ids": [
        1,
        2
      ],
      "total_value": 0,
      "weighted_value": 0
    },
    {
      "id": 36,
      "public_id": "vhICuX",
      "workspace_id": 2,
      "pipeline_id": 1,
      "name": "Example Stage",
      "sort_order": 2,
      "close_probability": 20,
      "opportunity_ids": [
        3,
        4
      ],
      "total_value": 0,
      "weighted_value": 0
    }
  ]
}