curl --request PUT \
--url https://api.hubapi.com/crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"displayOrder": 123,
"label": "<string>",
"metadata": {}
}
'{
"archived": false,
"createdAt": "2019-10-30T03:30:17.883Z",
"displayOrder": 0,
"id": "1234912",
"label": "In Progress",
"metadata": {
"ticketState": "OPEN"
},
"updatedAt": "2019-12-07T16:50:06.678Z"
}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.
curl --request PUT \
--url https://api.hubapi.com/crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"displayOrder": 123,
"label": "<string>",
"metadata": {}
}
'{
"archived": false,
"createdAt": "2019-10-30T03:30:17.883Z",
"displayOrder": 0,
"id": "1234912",
"label": "In Progress",
"metadata": {
"ticketState": "OPEN"
},
"updatedAt": "2019-12-07T16:50:06.678Z"
}Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
The order for displaying this pipeline stage. If two pipeline stages have a matching displayOrder, they will be sorted alphabetically by label.
A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline.
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.
Show child attributes
Show child attributes
Response
successful operation
A pipeline stage definition.
Whether the pipeline is archived.
The date the pipeline stage was created. The stages on default pipelines will have createdAt = 0.
The order for displaying this pipeline stage. If two pipeline stages have a matching displayOrder, they will be sorted alphabetically by label.
A unique identifier generated by HubSpot that can be used to retrieve and update the pipeline stage.
A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline.
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.
Show child attributes
Show child attributes
The date the pipeline stage was last updated.
The date the pipeline was archived. archivedAt will only be present if the pipeline is archived.
Defines the level of write access for the pipeline stage, with possible values being CRM_PERMISSIONS_ENFORCEMENT, READ_ONLY, or INTERNAL_ONLY.
CRM_PERMISSIONS_ENFORCEMENT, INTERNAL_ONLY, READ_ONLY Was this page helpful?