Account & Settings
Gerenciamento de aplicativo
Autenticação
Automação
CMS
Communication preferences
Conversas
Marketing
Scheduler
curl --request PUT \
--url https://api.hubapi.com/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"displayOrder": 123,
"label": "<string>",
"metadata": {}
}
'{
"archived": true,
"createdAt": "2023-11-07T05:31:56Z",
"displayOrder": 123,
"id": "<string>",
"label": "<string>",
"metadata": {},
"updatedAt": "2023-11-07T05:31:56Z",
"writePermissions": "CRM_PERMISSIONS_ENFORCEMENT",
"archivedAt": "2023-11-07T05:31:56Z"
}Replace a pipeline stage
Substitua todas as propriedades de uma fase de pipeline existente pelos valores fornecidos. A fase atualizada será retornada na resposta.
curl --request PUT \
--url https://api.hubapi.com/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"displayOrder": 123,
"label": "<string>",
"metadata": {}
}
'{
"archived": true,
"createdAt": "2023-11-07T05:31:56Z",
"displayOrder": 123,
"id": "<string>",
"label": "<string>",
"metadata": {},
"updatedAt": "2023-11-07T05:31:56Z",
"writePermissions": "CRM_PERMISSIONS_ENFORCEMENT",
"archivedAt": "2023-11-07T05:31:56Z"
}Supported products
Supported products
Required Scopes
Required Scopes
Autorizações
The access token received from the authorization server in the OAuth 2.0 flow.
Parâmetros de caminho
Corpo
A ordem para exibir esta fase do pipeline. Se duas fases do pipeline tiverem um "displayOrder" correspondente, elas serão classificadas em ordem alfabética pelo rótulo de associação.
Um rótulo usado para organizar fases de pipeline na UI do HubSpot. Cada rótulo de fase deve ser exclusivo dentro do pipeline.
Um objeto JSON contendo propriedades que não estão presentes em todos os pipelines de objeto.
Para pipelines de "deals", o campo "probability" é obrigatório ("{ "probability": 0.5 }"), e representa a probabilidade de um negócio ser fechado. Os valores possíveis estão entre 0,0 e 1,0 em incrementos de 0,1.
Para pipelines de "tickets", o campo "ticketState" é opcional ("{ "ticketState": "OPEN" }"), e representa se o ticket permanece aberto ou foi fechado por um membro da sua equipe de suporte. Os valores possíveis são "OPEN" ou "CLOSED".
Show child attributes
Show child attributes
Resposta
successful operation
Se o pipeline está arquivado ou não.
A data em que a fase do pipeline foi criada. As fases nos pipelines padrão terão createdAt = 0.
A ordem para exibir esta fase do pipeline. Se duas fases do pipeline tiverem um "displayOrder" correspondente, elas serão classificadas em ordem alfabética pelo rótulo de associação.
Um identificador exclusivo gerado pelo HubSpot que pode ser usado para recuperar e atualizar a fase do pipeline.
Um rótulo usado para organizar fases de pipeline na UI do HubSpot. Cada rótulo de fase deve ser exclusivo dentro do pipeline.
Um objeto JSON contendo propriedades que não estão presentes em todos os pipelines de objeto.
Para pipelines de "deals", o campo "probability" é obrigatório ("{ "probability": 0.5 }"), e representa a probabilidade de um negócio ser fechado. Os valores possíveis estão entre 0,0 e 1,0 em incrementos de 0,1.
Para pipelines de "tickets", o campo "ticketState" é opcional ("{ "ticketState": "OPEN" }"), e representa se o ticket permanece aberto ou foi fechado por um membro da sua equipe de suporte. Os valores possíveis são "OPEN" ou "CLOSED".
Show child attributes
Show child attributes
A data em que a fase do pipeline foi atualizada pela última vez.
Define o nível de acesso de gravação para a fase do pipeline, com os valores possíveis sendo CRM_PERMISSIONS_ENFORCEMENT, READ_ONLY ou INTERNAL_ONLY.
CRM_PERMISSIONS_ENFORCEMENT, INTERNAL_ONLY, READ_ONLY A data em que o pipeline foi arquivado. "archivedAt" somente estará presente se o pipeline estiver arquivado.