Create Pipeline

A new pipeline with its stages (default stages when none are given). 409 `pipeline_name_taken`.

API key access

Needs the crm:write scope with an API key (ro_pat_...). A signed-in session uses the caller's role.

POST/api/v1/pipelines

Authorization

AuthorizationBearer <token>

Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).

In: header

Header Parameters

X-Workspace-Id?string | null

Id of the workspace to act on (must be a member).

Request Body

namestring

Length1 <= length <= 100

stages?array<PipelineStageIn> | null

1-20 stages, at least one open. Default: Meeting booked, Qualified, Proposal, Negotiation, Won, Lost.

Response Body

curl -X POST "http://localhost:8000/api/v1/pipelines" \
  -H "X-Workspace-Id: string" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string"
  }'

curl -X POST "http://localhost:8000/api/v1/pipelines" \  -H "X-Workspace-Id: string" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "position": 0,
  "is_default": true,
  "stages": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "pipeline_id": "ec036e81-7903-4e4d-bbfa-ac8516341cf0",
      "name": "string",
      "position": 0,
      "kind": "open",
      "probability": 0,
      "required_fields": [
        "value"
      ]
    }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Authorization

Header Parameters

Request Body

Response Body

201

422