Sign in

v14

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-279719892.3 MB
Basic

Replace a pipeline stage

Replace all the properties of an existing pipeline stage with the values provided. The updated stage will be returned in the response.

put/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId}

Path parameters

objectTypestring required
pipelineIdstring required
stageIdstring required

Request body

displayOrderinteger required

The order for displaying this pipeline stage. If two pipeline stages have a matching displayOrder, they will be sorted alphabetically by label.

labelstring required

A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline.

metadataobject required

A JSON object containing properties that are not present on all object pipelines.

For deals pipelines, the probability field is required ({ "probability": 0.5 }), and represents the likelihood a deal will close. Possible values are between 0.0 and 1.0 in increments of 0.1.

For tickets pipelines, the ticketState field is optional ({ "ticketState": "OPEN" }), and represents whether the ticket remains open or has been closed by a member of your Support team. Possible values are OPEN or CLOSED.

Response

successful operation

archivedboolean required

Whether the pipeline is archived.

archivedAtstring date-time

The date the pipeline was archived. archivedAt will only be present if the pipeline is archived.

createdAtstring date-time required

The date the pipeline stage was created. The stages on default pipelines will have createdAt = 0.

displayOrderinteger required

The order for displaying this pipeline stage. If two pipeline stages have a matching displayOrder, they will be sorted alphabetically by label.

idstring required

A unique identifier generated by HubSpot that can be used to retrieve and update the pipeline stage.

labelstring required

A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline.

metadataobject required

A JSON object containing properties that are not present on all object pipelines.

For deals pipelines, the probability field is required ({ "probability": 0.5 }), and represents the likelihood a deal will close. Possible values are between 0.0 and 1.0 in increments of 0.1.

For tickets pipelines, the ticketState field is optional ({ "ticketState": "OPEN" }), and represents whether the ticket remains open or has been closed by a member of your Support team. Possible values are OPEN or CLOSED.

updatedAtstring date-time required

The date the pipeline stage was last updated.

writePermissions'CRM_PERMISSIONS_ENFORCEMENT' | 'INTERNAL_ONLY' | 'READ_ONLY' required

Defines the level of write access for the pipeline stage, with possible values being CRM_PERMISSIONS_ENFORCEMENT, READ_ONLY, or INTERNAL_ONLY.