Pular para o conteúdo principal
PATCH
Atualizar pipeline (parcial)

Supported products

Autorizações

Authorization
string
header
obrigatório

The access token received from the authorization server in the OAuth 2.0 flow.

Parâmetros de caminho

objectType
string
obrigatório

O tipo de objeto associado ao pipeline, como negócios ou tickets.

pipelineId
string
obrigatório

O identificador exclusivo do pipeline a ser atualizado.

Parâmetros de consulta

validateDealStageUsagesBeforeDelete
boolean
padrão:true

Um booleano que indica se o uso das fases do negócio deve ser validado antes da exclusão. O padrão é verdadeiro.

validateReferencesBeforeDelete
boolean
padrão:true

Um booleano que indica se as referências devem ser validadas antes da exclusão. O padrão é verdadeiro.

Corpo

application/json
archived
boolean

Um valor booleano que indica se o pipeline está arquivado.

displayOrder
integer<int32>

Um número inteiro que indica a posição do pipeline em uma lista, o que determina sua ordem de exibição.

label
string

O nome do pipeline, representado como uma string.

Resposta

successful operation

archived
boolean
obrigatório

Um booleano que indica se o pipeline está arquivado.

createdAt
string<date-time>
obrigatório

A data e a hora em que o pipeline foi criado, no formato ISO 8601.

displayOrder
integer<int32>
obrigatório

Um número inteiro que indica a ordem em que o pipeline aparece em relação a outros pipelines.

id
string
obrigatório

Um identificador de string exclusivo para o pipeline.

label
string
obrigatório

O nome ou título do pipeline, representado como string.

stages
object[]
obrigatório

Uma matriz de objetos PipelineStage que definem as fases dentro deste pipeline.

updatedAt
string<date-time>
obrigatório

A data e a hora da última atualização do pipeline, no formato ISO 8601.

archivedAt
string<date-time>

A data e hora em que o pipeline foi arquivado, no formato ISO 8601.

Última modificação em 6 de outubro de 2026