Pular para o conteúdo principal
PUT
Atualizar etapa

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 ao qual o pipeline pertence, como negócios ou tickets.

pipelineId
string
obrigatório

O identificador exclusivo do pipeline que contém a fase.

stageId
string
obrigatório

O identificador exclusivo da fase a ser atualizada.

Corpo

application/json
displayOrder
integer<int32>
obrigatório

Um número inteiro que indica a posição da fase no pipeline.

label
string
obrigatório

O nome da fase do pipeline, representado como uma string.

metadata
object
obrigatório

Um objeto que contém propriedades adicionais relacionadas à fase, em que cada propriedade é uma string.

Resposta

successful operation

archived
boolean
obrigatório

Um booleano que indica se a fase está arquivada.

createdAt
string<date-time>
obrigatório

A data e a hora em que a fase foi criada, no formato ISO 8601.

displayOrder
integer<int32>
obrigatório

Um número inteiro que indica a posição desta fase no pipeline, determinando sua ordem em relação às outras fases.

id
string
obrigatório

Um identificador de string exclusivo para a fase do pipeline.

label
string
obrigatório

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

metadata
object
obrigatório

Um objeto que contém metadados adicionais para a fase, com valores de string para cada propriedade.

updatedAt
string<date-time>
obrigatório

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

writePermissions
enum<string>
obrigatório

Uma string que indica as permissões de gravação para a fase. Os valores válidos incluem "CRM_PERMISSIONS_ENFORCEMENT", "READ_ONLY" e "INTERNAL_ONLY".

Opções disponíveis:
CRM_PERMISSIONS_ENFORCEMENT,
INTERNAL_ONLY,
READ_ONLY
archivedAt
string<date-time>

A data e a hora em que a fase foi arquivada, no formato ISO 8601.

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