Pular para o conteúdo principal
POST
Criar um registro de pipeline

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 registro a criar, 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 criou.

Required string length: 1 - 255
Exemplo:

"erp-opp-981-create"

Parâmetros de caminho

workspaceId
string<uuid>
obrigatório

Identificador único do workspace (UUID v4).

Exemplo:

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

Corpo

application/json

Corpo da solicitação para criar um registro de pipeline.

contact
Contact · object
obrigatório

O contato ao qual o registro pertence, informado por exatamente um de id, phone ou email.

pipelineId
string | null

Pipeline em que o registro será criado. Por padrão, o pipeline padrão do workspace.

Required string length: 1 - 255
Exemplo:

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

stageId
string | null

Etapa em que o registro começa. Por padrão, a etapa inicial do pipeline; uma etapa final é recusada. Os requisitos da etapa se aplicam, como um contato completo.

Required string length: 1 - 255
Exemplo:

"stage-new"

name
string | null

Nome do registro, de até 200 caracteres. Se ausente ou em branco, usa-se o nome completo do contato, depois seu celular e depois seu e-mail.

Exemplo:

"Acme renewal 2027"

externalId
string | null

Id do registro no seu sistema, único por pipeline. Um segundo registro com o mesmo externalId no mesmo pipeline é recusado com 409 e o id do registro existente.

Required string length: 1 - 255
Exemplo:

"ERP-OPP-981"

values
Values · object

Valores dos atributos do registro, indexados por id de atributo. Só são aceitos atributos de escopo RECORD da versão atual do pipeline, cada um verificado conforme seu tipo (TEXT até 2000 caracteres); um valor null, um texto em branco e uma lista vazia são omitidos.

Exemplo:

Resposta

O registro foi criado, ou uma solicitação anterior com a mesma chave o criou.

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