Sales pipeline stages
A defined point in a deal's progress within a sales pipeline, with its win probability.
- API name:
salespipelinestages - Domain: Sales
- Modules: Sales analytics, Sales
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Pipeline | salespipelineId | Reference | Yes | |
| Position | rank | Order rank | Yes | |
| Name | label | Text I18n | ||
| Forecast category | forecastCategory | Constant | Yes | Fixed option from the allowed set for this field. |
| Color | color | Color | Yes | |
| Closure probability (%) | probability | Percent | Estimated success percentage assigned automatically to deals entering this stage. | |
| Rotting days | rottingDays | Whole Number | Days in this stage before highlighting the card in the Kanban for stagnation. Leave blank to disable. | |
| Status | status | Constant | Yes | Stage type in the pipeline. Fixed at create; to correct it before publish, delete the stage and create it again. |
| Tags | tagIds | Tags | ||
| Description | description | Text Area I18n | ||
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Published by | publishedBy | User | ||
| Published at | publishedAt | Date and Time | ||
| Disabled by | disabledBy | User | ||
| Disabled at | disabledAt | Date and Time | ||
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.
| Field | Points to | Kind |
|---|---|---|
Pipeline salespipelineId | Sales pipelines | owned by |
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event salespipelinestages.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new stage. | App · API · MCP · CLI |
| Edit | update | Save changes to this stage. | App · API · MCP · CLI |
| Disable | disable | Turn this stage off for new use. Existing references stay. Enable it again to use it. | App · API · MCP · CLI |
| Enable | undisable | Turn this stage back on for new use. | App · API · MCP · CLI |
| Delete | delete | Delete this stage and the data that belongs with it. This cannot be undone. | App · API · MCP · CLI |