Pipeline stages API
Stages are ordered columns inside a pipeline. They are created, reordered, renamed, and removed through pipeline-stages across deals, conversations, and tickets.
Common fields (from app usage)
| Field | Type | Description |
|---|---|---|
id | String or number | Stage id (used in PATCH / DELETE paths as returned by the API). |
pipeline_id | Number | Parent pipeline. |
organization_id | Number | Owning organization (sent on create in the UI). |
name | String | Stage label. |
order | Number | Zero-based sort order within the pipeline. |
rotting_days | Number or null | Optional; deal stages may expose rotting days in the deal pipeline editor. |
Related
- Pipelines API
- List pipeline stages
- Patch conversation — set
pipeline_idandpipeline_stage_idon a conversation - Update deal — set
pipeline_stage_id(andpipeline_idwhen changing pipeline) on a deal - Update support ticket — set
pipeline_id/pipeline_stage_idwhen your ticket model stores them
Report an issue with this documentation
Please log in to report issues with our documentation.