Pipelines

Summarize a pipeline board the way the Pipeline page and the dashboard's Pipeline widget do: every stage with its deal count and total value, plus the board's split into in-progress (open), won, and lost deals with the money in each. 'Lost' counts both lost and abandoned deals — closed without a win. All values are integer cents. Read-only.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/pipelines.board \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "pipeline_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool pipelines_board at https://app.chirply.io/api/mcp, same bearer token, same input.

Create a new deal pipeline and seed it with the starter stages (New → Qualified → Proposal → Won → Lost) so its board is usable immediately. It is added after the existing pipelines and does not become the default.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/pipelines.create \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Example"
  }'

Over MCP the same operation is the tool pipelines_create at https://app.chirply.io/api/mcp, same bearer token, same input.

Permanently delete a pipeline. DESTRUCTIVE: the database cascades, so every stage in the pipeline AND every deal on its board is deleted with it — deals are not moved anywhere. Cannot be undone.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/pipelines.delete \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool pipelines_delete at https://app.chirply.io/api/mcp, same bearer token, same input.

Fetch one pipeline together with its stages, in board order. Omit the id to get the org's default pipeline.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/pipelines.get \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool pipelines_get at https://app.chirply.io/api/mcp, same bearer token, same input.

List the organization's deal pipelines in board order, with the default one flagged. Call this first when you need a pipeline_id.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/pipelines.list \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 25,
    "offset": 0
  }'

Over MCP the same operation is the tool pipelines_list at https://app.chirply.io/api/mcp, same bearer token, same input.

Relabel the currency stored on this account's deals — for example correcting deals that were stamped usd by the old default when the business trades in gbp. This changes the LABEL only: it does not convert amounts, does not touch the numbers, and does not move money. A deal worth 1000 (ten pounds or ten dollars) is still worth 1000 afterwards, it is simply denominated differently. Use it once after setting the account's currency in Settings > Business; it is not part of normal day-to-day work. Returns how many deals were changed.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/pipelines.relabel_deal_currency \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "example",
    "from": "example"
  }'

Over MCP the same operation is the tool pipelines_relabel_deal_currency at https://app.chirply.io/api/mcp, same bearer token, same input.

Change a pipeline's name. Stages and deals are untouched — this is the name field in the pipeline settings dialog.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/pipelines.rename \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "name": "Example"
  }'

Over MCP the same operation is the tool pipelines_rename at https://app.chirply.io/api/mcp, same bearer token, same input.

Set the left-to-right order of the pipelines in the switcher. Pass every pipeline id in the order you want; any pipeline you leave out keeps its current position.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/pipelines.reorder \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "pipeline_ids": [
      "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
    ]
  }'

Over MCP the same operation is the tool pipelines_reorder at https://app.chirply.io/api/mcp, same bearer token, same input.

Set up the starter 'Sales' pipeline (New → Qualified → Proposal → Won → Lost) for an org that has no pipeline yet, and mark it default. Does nothing if the org already has at least one pipeline.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/pipelines.seed_default \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Over MCP the same operation is the tool pipelines_seed_default at https://app.chirply.io/api/mcp, same bearer token, same input.

Mark one pipeline as the org's default. The default is what the Pipeline page opens on and what a deal created without a pipeline_id lands in; any other pipeline loses the flag.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/pipelines.set_default \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool pipelines_set_default at https://app.chirply.io/api/mcp, same bearer token, same input.

Switch a board between a sales pipeline and a process board. With tracks_value true each card carries a value and the columns total it; false hides the value field and the totals, which is what you want for onboarding, fulfilment, hiring or any board where the cards aren't sales. This is a display decision only — values already saved on the deals are kept, so switching back restores them.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/pipelines.set_value_tracking \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "tracks_value": true
  }'

Over MCP the same operation is the tool pipelines_set_value_tracking at https://app.chirply.io/api/mcp, same bearer token, same input.