Delete a pipeline stage

Deletes a stage. This is a soft delete: the stage gets a deleted_at timestamp and no longer appears in list or get. What happens to the records in the stage depends on the pipeline type:

Pipeline typeRecords in the stage
dealRequired: pass move_deals_to_stage_id with another stage of the same pipeline. The deals are moved there (and their stage history updated) before the stage is deleted.
conversationOptional: pass move_conversations_to_stage_id to move them to another stage of the same pipeline. Without it (or with unassigned), the conversations stay in the pipeline with no stage.
ticketThe stage cannot be deleted while it has support tickets. Move them first.

Endpoint

DELETE
/pipeline-stages/:id

Query parameters

NameTypeRequiredDescription
move_deals_to_stage_idintegerWhen the deal stage has dealsDestination stage in the same pipeline.
move_conversations_to_stage_idinteger | unassignedNoDestination stage in the same pipeline for conversations.

Request

Response

Returns the deleted pipeline stage object with deleted_at set.

json

Errors

StatusWhen
400 Bad RequestDeals are in the stage and no destination was given, the destination is the same stage or belongs to another pipeline, or the stage still has support tickets.
403 ForbiddenThe API key's user has the member role in the organization.

Report an issue with this documentation

Please log in to report issues with our documentation.