Pular para o conteúdo principal
POST
Mover um registro de pipeline para outra etapa

Autorizações

x-api-key
string
header
obrigatório

Copy the API key as provided by the Bridge Console.

Cabeçalhos

Idempotency-Key
string
obrigatório

Uma chave que você escolhe para cada alteração, como o id de operação do seu sistema. Envie a mesma chave ao repetir a solicitação: por 24 horas ela responde com o registro que a primeira solicitação alterou.

Required string length: 1 - 255
Exemplo:

"erp-opp-981-won"

Parâmetros de caminho

workspaceId
string<uuid>
obrigatório

Identificador único do workspace (UUID v4).

Exemplo:

"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"

recordId
string
obrigatório

Identificador único do registro de pipeline.

Required string length: 1 - 255
Exemplo:

"0d3c7f0e-5a43-5c0e-9f53-1f6a4b2e7d11"

Corpo

application/json

Corpo da solicitação para mover um registro de pipeline para outra etapa do seu pipeline.

stageId
string
obrigatório

Etapa para a qual o registro será movido, da versão do pipeline que o registro segue. Uma etapa final fecha o registro. Os requisitos da etapa se aplicam, como um contato completo.

Required string length: 1 - 255
Exemplo:

"stage-won"

expectedRevision
integer | null

A revision do registro que você leu por último. Quando deixa de ser a atual, a alteração falha com 409 BRIDGE_PIPELINE_0101 e o registro atual em extra.currentRecord. Sem ela, a alteração se aplica ao registro como a solicitação o lê, então outra alteração feita no mesmo instante ainda pode fazê-la falhar com esse 409.

Intervalo obrigatório: x >= 1
Exemplo:

3

reasonId
string | null

Motivo de fechamento ativo do pipeline, conforme GET /pipelines/{pipelineId}. Apenas para uma movimentação para uma etapa final, e opcional nesse caso.

Maximum string length: 255
Exemplo:

"reason-price"

reasonNote
string | null

Texto livre que explica o motivo de fechamento, de até 500 caracteres. Requer reasonId.

Exemplo:

"Chose a cheaper provider"

Resposta

O registro como fica após a alteração, ou após uma solicitação anterior com a mesma chave.

Um registro de um pipeline, como uma oportunidade de venda de um contato.

id
string
obrigatório

Identificador único do registro.

Exemplo:

"0d3c7f0e-5a43-5c0e-9f53-1f6a4b2e7d11"

pipelineId
string
obrigatório

Pipeline ao qual o registro pertence.

Exemplo:

"5d0b8f8e-3c1a-4a4e-9a57-2f6f3e1c9b10"

pipelineVersion
integer
obrigatório

Versão do pipeline que o registro segue.

Exemplo:

3

stageId
string
obrigatório

Etapa em que o registro está.

Exemplo:

"stage-new"

state
enum<string>
obrigatório

OPEN enquanto o registro está em uma etapa aberta, FINAL quando está em uma etapa final.

Opções disponíveis:
OPEN,
FINAL
Exemplo:

"OPEN"

name
string
obrigatório

Nome do registro.

Exemplo:

"Acme renewal 2027"

contact
Contact · object
obrigatório

O contato ao qual o registro pertence.

source
enum<string>
obrigatório

Como o registro foi criado: API, ADVISOR, INBOUND_SESSION ou FROM_PIPELINE.

Opções disponíveis:
ADVISOR,
API,
INBOUND_SESSION,
FROM_PIPELINE
Exemplo:

"API"

revision
integer
obrigatório

Aumenta em um a cada vez que o registro muda.

Exemplo:

1

createdAt
string
obrigatório

Quando o registro foi criado.

Exemplo:

"2026-11-11T15:00:00.000Z"

updatedAt
string
obrigatório

Quando o registro mudou pela última vez.

Exemplo:

"2026-11-11T15:00:00.000Z"

values
Values · object

Valores dos atributos do registro, indexados por id de atributo.

Exemplo:
ownerId
string | null

Id do Usuário do Bridge responsável pelo registro. Resolva-o com GET /users/{userId}.

Exemplo:

null

externalId
string | null

O id do registro no seu sistema, quando foi criado com um.

Exemplo:

"ERP-OPP-981"

closeReason
RecordCloseReasonResponse · object | null

O motivo com o qual um registro fechado foi fechado.

closedAt
string | null

Quando o registro chegou a uma etapa final; null enquanto está aberto.

Exemplo:

null