Client - Pipelines

Manage a client's placements on sales pipelines (kanban cards). Provides CRUD operations for putting a client (typically an Active Prospect) on a pipeline, plus a PATCH endpoint for updating only the stage (used for drag-and-drop). Also serves top-level pipeline card queries that are not scoped to a single client, returning lightweight summary projections for kanban board display with filtering by pipeline code and stage code.

OpenAPI Spec

Guides Operations Schemas

GET List Client Pipelines for Client
Lists all Client Pipelines for the specified client. Requires: ViewAll on Pipelines.
/tenants/{tenant}/clients/{client}/pipelines/clientpipeline
POST Create Client Pipeline for Client
Creates a new Client Pipeline for the specified client. Requires: Create on Pipelines.
/tenants/{tenant}/clients/{client}/pipelines/clientpipeline
GET Get Client Pipeline for Client
Gets a Client Pipeline for the specified client. Requires: ViewAll on Pipelines.
/tenants/{tenant}/clients/{client}/pipelines/clientpipeline/{code}
PUT Update Client Pipeline for Client
Updates the specified Client Pipeline for the specified client. Requires: Update on Pipelines.
/tenants/{tenant}/clients/{client}/pipelines/clientpipeline/{code}
DELETE Delete Client Pipeline for Client
Deletes a Client Pipeline for the specified client. Requires: Delete on Pipelines.
/tenants/{tenant}/clients/{client}/pipelines/clientpipeline/{code}
PATCH Update Client Pipeline Stage
Updates only the stage for a client pipeline card, targeted by the card's own code. Designed for kanban board drag-and-drop — avoids the overhead of a...
/tenants/{tenant}/clients/{client}/pipelines/{code}/stage
PUT Update Client Pipeline Deal
Replaces a client pipeline card's deal (value and likelihood 0-100%), targeted by the card's own code. Both fields are sent every time; null clears on...
/tenants/{tenant}/clients/{client}/pipelines/{code}/deal
GET List Client Pipeline Summaries
Returns a paged list of client pipeline card summaries across all clients. Returns a lightweight projection designed for kanban board display. Filter ...
/tenants/{tenant}/clientpipelines
GET Get Client Pipeline Stage Counts
Returns per-stage card counts for a pipeline's kanban board, including each stage's display settings (icon, colour, sort order). One row per stage, in...
/tenants/{tenant}/clientpipelines/stage-counts