Pipeline stages
A stage is one column of a pipeline, in a given order. Deals, conversations and support tickets point to their current stage with pipeline_stage_id.
Endpoints
| Method | Path | Description |
|---|---|---|
GET | /pipeline-stages | List pipeline stages |
GET | /pipeline-stages/:id | Get a pipeline stage |
POST | /pipeline-stages | Create a pipeline stage |
PATCH | /pipeline-stages/:id | Update a pipeline stage |
DELETE | /pipeline-stages/:id | Delete a pipeline stage |
Reads are limited to your API key's organization and to stages of pipelines the key's user can see (see pipeline visibility). Creating, updating and deleting stages is not allowed when the key's user has the member role in the organization.
The pipeline stage object
json
Fields
| Field | Type | Description |
|---|---|---|
id | integer | Read-only. Unique ID. |
name | string | Stage name. Required on create. |
pipeline_id | integer | Pipeline the stage belongs to. Required on create. |
organization_id | integer | Organization that owns the stage. Required on create. |
order | number | Position in the pipeline, starting at 0. Required on create. |
rotting_days | number | null | Deal pipelines: days after which a deal that has not moved is shown as rotting. |
created_by_user_id | integer | Read-only. User who created the stage (the API key's user). |
created_at | string (date-time) | Read-only. Creation time. |
updated_at | string (date-time) | Read-only. Last update time. |
deleted_at | string (date-time) | null | Read-only. Set when the stage is deleted. |
Related
Report an issue with this documentation
Please log in to report issues with our documentation.