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

MethodPathDescription
GET/pipeline-stagesList pipeline stages
GET/pipeline-stages/:idGet a pipeline stage
POST/pipeline-stagesCreate a pipeline stage
PATCH/pipeline-stages/:idUpdate a pipeline stage
DELETE/pipeline-stages/:idDelete 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

FieldTypeDescription
idintegerRead-only. Unique ID.
namestringStage name. Required on create.
pipeline_idintegerPipeline the stage belongs to. Required on create.
organization_idintegerOrganization that owns the stage. Required on create.
ordernumberPosition in the pipeline, starting at 0. Required on create.
rotting_daysnumber | nullDeal pipelines: days after which a deal that has not moved is shown as rotting.
created_by_user_idintegerRead-only. User who created the stage (the API key's user).
created_atstring (date-time)Read-only. Creation time.
updated_atstring (date-time)Read-only. Last update time.
deleted_atstring (date-time) | nullRead-only. Set when the stage is deleted.

Related

Report an issue with this documentation

Please log in to report issues with our documentation.