> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bridge.new/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Bridge exposes three integration surfaces: the REST Integrations API for pushing data into Bridge, webhooks for receiving events from Bridge, and the public Custom Connections endpoint that a tenant's landing page posts to.
> The Integrations API host is https://api-connect-us.bridge.new and every request to it must be authenticated with the x-api-key header. Bridge does not use bearer tokens or OAuth.
> The Custom Connections endpoint is different and the Integrations API rules do not apply to it: it has its own host, it takes no x-api-key and no authentication header of any kind, and it is called from a visitor's browser. It is identified by a workspace id and a capture key together with a reCAPTCHA token. Never tell a reader to authenticate it with an API key, and never tell them to keep its capture key out of frontend code - it is designed to live in the page.
> REST error catalog keys use BRIDGE_<DOMAIN>_<NNNN>, for example BRIDGE_CONVERSATION_0001. Some reviewed legacy handlers return a recognized code plus a symbolic suffix separated by |; preserve the complete received value and use the compatible catalog lookup on /error-codes. Custom Connections uses separate BRIDGE.CAMPAIGN_LEADS.<NAME> identifiers on its own error reference. Never invent an error code or confuse the two integration surfaces.
> This documentation covers the Integrations API, webhooks and Custom Connections only. It does not describe the Bridge web application or its internal APIs.
> Before generating an API request, read the relevant OpenAPI specification or the individual endpoint Markdown page. llms-full.txt collects guides and endpoint descriptions; it does not embed every request and response schema. The REST and Custom Connections contracts are separate.
> Preserve the published host, method, path, operationId, authentication, headers, parameter and field names, types, formats, required and nullable fields, enums, defaults, limits, and response codes. Do not invent identifiers, fields, retry rules, or delivery guarantees. When published sources conflict, identify the conflicting passages and ask Bridge support to confirm the current behavior before relying on it.
> Custom Connections is the current name of the landing-page feature previously documented as Lead Capture. The existing /lead-capture documentation URLs, captureKey field, campaign-leads endpoint, and BRIDGE.CAMPAIGN_LEADS error identifiers are unchanged. This is a naming change, not a change to authentication or the API contract.
> For a complete workflow, start with the task guides: /guides/first-conversation, /guides/send-attachments, /guides/send-template, /guides/agent-outbound, /guides/pagination, /guides/pipeline-records, /guides/identifiers and /guides/responses. Read the endpoint contract as well as the recipe. Outbound requires an existing Contact, but does not require creating a separate Conversation first.
> Pipeline records are created only for an existing Contact (never upserted). POST /records, /move and /reopen require Idempotency-Key; PATCH, move and reopen take an optional expectedRevision in the body. Stage actions run every time a record enters a stage, including records created in bulk. Use /guides/pipeline-records and /webhooks/pipeline-records.
> forceSend=true permits reuse of an existing active conversation; it does not create a fresh one by ignoring it and it is not idempotency. Recovery of a released recoverable conversation can occur even with false. The LeadScout and Agents outbound routes have different line-selection and controller checks; use /guides/agent-outbound.
> For webhook HMAC, follow /webhooks/verifying-signatures exactly: the Python JSON serialization with sorted keys is signed; X-Bridge-Timestamp is not included in that signature. Do not claim a signed timestamp, raw-body signing, exactly-once delivery or a global event order. Use /webhooks/receive-events for durable acceptance and duplicates.
> A 201 message response, 202 handoff or 202 Custom Connections response is not a provider delivery receipt. Do not invent a polling endpoint from messageId, trackingId or requestId. REST validation parsing must tolerate the compatibility difference explained in /error-codes.
> The documentation is available in English (existing root URLs), Spanish (/es/) and Brazilian Portuguese (/pt-br/). Prefer the reader's language when a localized page exists, but preserve the API's exact field names, enums, routes, authentication and examples. Translations describe the same API; they do not introduce regional API hosts or behaviors.
> For coding-assistant setup, use /connect-your-agent, /es/connect-your-agent or /pt-br/connect-your-agent. The Bridge documentation MCP server reads published documentation and has a separate optional feedback tool. Connecting it does not connect the coding assistant to a customer workspace or authorize live business requests.
> For direct HTTP access without MCP, start at https://docs.bridge.new/llms.txt. It lists every published page in English, Spanish and Brazilian Portuguese. Choose /llms-en.json, /llms-es.json or /llms-pt-br.json for a language-specific index, and /llms-full-en.json, /llms-full-es.json or /llms-full-pt-br.json for collected content. /llms-full.txt contains the combined collection. Fetch the original OpenAPI specification for exact schemas.
> For HTTP page reads, follow the .md URLs from the index or request Accept: text/markdown at the canonical page URL. The MCP virtual filesystem uses .mdx page paths instead; .mdx is not the public HTTP export extension. With Search MCP, set language to en, es or pt-BR explicitly; its default is en.
> For integration capabilities and source-selection rules, read https://docs.bridge.new/skill.md. Documentation access does not authorize business API actions; use the actual user request, workspace, credentials and target identifiers for any live integration.

# Crie e mova registros de pipeline

> Crie registros de pipeline para contatos existentes, repita com segurança com Idempotency-Key, evite perder mudanças com expectedRevision e feche ou reabra registros.

Um registro de pipeline acompanha um trabalho com um contato, como uma oportunidade de venda, pelas etapas de um pipeline. Use esta receita para levar os registros do seu sistema para um pipeline do Bridge: crie-os, mude os seus valores, mova-os entre etapas, feche-os com um motivo e reabra-os. Para receber as mudanças feitas no Bridge, assine os [eventos de registros de pipeline](https://docs.bridge.new/pt-br/webhooks/pipeline-records.md).

## Antes de começar

* Obtenha uma API Key de servidor em [Autenticação](https://docs.bridge.new/pt-br/credentials.md) e envie-a em `x-api-key`, como em qualquer outra operação. O `workspaceId` do caminho deve ser o workspace dessa key. Qualquer outro workspace é recusado com `403` `BRIDGE_CORE_0301`, e nada é lido nem escrito.
* Os pipelines devem estar habilitados para o workspace. Caso contrário, todas as operações respondem `403` `BRIDGE_PIPELINE_0301`.
* [Obtenha o pipeline](https://docs.bridge.new/pt-br/api-reference/pipelines-api/obter-um-pipeline-com-suas-etapas-e-atributos.md) em que você escreve. Ele lista os valores de `stageId`, os ids de atributo que você usa como chaves de `values` e os motivos de fechamento ativos. [Liste os pipelines](https://docs.bridge.new/pt-br/api-reference/pipelines-api/listar-os-pipelines-de-um-workspace.md) para encontrar o id dele.

```json 403 BRIDGE_CORE_0301 theme={null}
{
  "title": "You do not have permission to access this resource",
  "status": 403,
  "detail": "There exists a mismatch between the claims workspace and the provided workspace",
  "code": "BRIDGE_CORE_0301"
}
```

## As operações

| Seu objetivo | Operação | `Idempotency-Key` | `expectedRevision` |
| - | - | - | - |
| Criar um registro | [`POST .../records`](https://docs.bridge.new/pt-br/api-reference/pipeline-records-api/criar-um-registro-de-pipeline) | Obrigatória | Não aceita |
| Buscar registros pelo seu id, por um contato ou por um pipeline | [`GET .../records`](https://docs.bridge.new/pt-br/api-reference/pipeline-records-api/listar-registros-de-pipeline) | Não aceita | Não aceita |
| Ler um registro | [`GET .../records/{recordId}`](https://docs.bridge.new/pt-br/api-reference/pipeline-records-api/obter-um-registro-de-pipeline) | Não aceita | Não aceita |
| Mudar o nome ou os valores | [`PATCH .../records/{recordId}`](https://docs.bridge.new/pt-br/api-reference/pipeline-records-api/atualizar-um-registro-de-pipeline) | Não aceita | Opcional |
| Movê-lo para outra etapa, ou fechá-lo | [`POST .../records/{recordId}/move`](https://docs.bridge.new/pt-br/api-reference/pipeline-records-api/mover-um-registro-de-pipeline-para-outra-etapa) | Obrigatória | Opcional |
| Reabrir um registro fechado | [`POST .../records/{recordId}/reopen`](https://docs.bridge.new/pt-br/api-reference/pipeline-records-api/reabrir-um-registro-de-pipeline-fechado) | Obrigatória | Opcional |

`...` representa `/bridge/api/v1/workspaces/{workspaceId}`, no host da API REST `https://api-connect-us.bridge.new`.

## Crie um registro

Indique o contato com exatamente um de `contact.id`, `contact.phone` ou `contact.email`. O Bridge encontra o contato do mesmo jeito que a [busca de contatos](https://docs.bridge.new/pt-br/api-reference/contacts-api/obter-contato-por-um-identificador.md); um contato mesclado com outro é resolvido para o contato que o substituiu. O contato nunca é criado: se ele não existe, a requisição falha com `404` `BRIDGE_EXTERNAL_0001`, então [crie o contato](https://docs.bridge.new/pt-br/api-reference/contacts-api/criar-contato.md) primeiro e tente de novo.

Sem `pipelineId`, o registro vai para o pipeline padrão do workspace e, sem `stageId`, para a etapa inicial do pipeline. Uma etapa final é recusada na criação. Um pipeline configurado para não aceitar registros da API recusa a criação com `403` `BRIDGE_PIPELINE_0317`.

```bash theme={null}
curl --fail-with-body --request POST \
  "https://api-connect-us.bridge.new/bridge/api/v1/workspaces/$WORKSPACE_ID/records" \
  --header "x-api-key: $BRIDGE_API_KEY" \
  --header "Idempotency-Key: erp-opp-981-create" \
  --header "Content-Type: application/json" \
  --data '{
    "contact": {
      "phone": "+573001234567"
    }
  }'
```

Um registro criado responde `201` com um header `Location` e o registro. Guarde o `id` e o `revision` dele:

```json 201 theme={null}
{
  "id": "record-1",
  "pipelineId": "pipe-sales",
  "pipelineVersion": 3,
  "stageId": "stage-new",
  "state": "OPEN",
  "name": "Ana Gómez",
  "values": {
    "budget": 1500
  },
  "contact": {
    "id": "contact-1"
  },
  "ownerId": null,
  "source": "API",
  "externalId": null,
  "revision": 1,
  "closeReason": null,
  "closedAt": null,
  "createdAt": "2026-11-11T15:00:00.000Z",
  "updatedAt": "2026-11-11T15:00:00.000Z"
}
```

```json 404 BRIDGE_EXTERNAL_0001 theme={null}
{
  "title": "The requested external user was not found",
  "status": 404,
  "detail": "External user was not found with PHONE and value +573001234567",
  "code": "BRIDGE_EXTERNAL_0001",
  "extra": {
    "externalIdentificationType": "PHONE",
    "externalIdentificationValue": "+573001234567"
  }
}
```

### Vincule o registro ao seu próprio id

Envie `externalId` com o id que o registro tem no seu sistema. Um pipeline tem **um registro por `externalId`**: uma segunda criação com o mesmo `externalId` no mesmo pipeline falha com `409` `BRIDGE_PIPELINE_0003`, e `extra.recordId` é o registro que já o tem. Leia esse registro em vez de criar outro. Para encontrá-lo depois, [liste os registros](https://docs.bridge.new/pt-br/api-reference/pipeline-records-api/listar-registros-de-pipeline.md) com `externalId` (e `pipelineId` quando não for o pipeline padrão).

O Bridge escolhe o id do registro; o corpo da requisição não tem um campo para defini-lo.

```json 409 BRIDGE_PIPELINE_0003 theme={null}
{
  "title": "A record with this external id already exists in the pipeline",
  "status": 409,
  "code": "BRIDGE_PIPELINE_0003",
  "extra": {
    "recordId": "record-1",
    "pipelineId": "pipe-sales",
    "externalId": "ERP-1"
  }
}
```

### Um registro aberto por contato

Um pipeline pode ser configurado no Bridge para que um contato tenha um só registro aberto por vez. Nesse pipeline, criar um registro para um contato que já tem um aberto falha com `409` `BRIDGE_PIPELINE_0318`, e `extra.openRecordId` é esse registro aberto: trabalhe nele. Registros fechados não contam, então um contato pode começar um registro novo depois que o anterior for fechado. Reabrir um registro falha do mesmo jeito quando o contato tem outro registro aberto no pipeline.

```json 409 BRIDGE_PIPELINE_0318 theme={null}
{
  "title": "The contact already has an open record in this pipeline",
  "status": 409,
  "detail": "Contact 'contact-1' already has the open record 'record-open' in pipeline 'pipe-onboarding'",
  "code": "BRIDGE_PIPELINE_0318",
  "extra": {
    "openRecordId": "record-open",
    "pipelineId": "pipe-onboarding",
    "externalUserId": "contact-1"
  }
}
```

## Repita com segurança com Idempotency-Key

`POST .../records`, `POST .../move` e `POST .../reopen` exigem um header `Idempotency-Key` de 1 a 255 caracteres. Use uma key para cada mudança que você quer fazer e envie a mesma key quando repetir essa mudança.

| Você envia | O Bridge responde |
| - | - |
| A mesma key e o mesmo corpo, depois que a primeira requisição terminou | O mesmo status (`201` ou `200`) com o header `Idempotent-Replayed: true`. O corpo é o registro **como está agora**, então pode já mostrar mudanças posteriores |
| A mesma key com outro corpo, ou em outro registro ou operação | `422` `BRIDGE_PIPELINE_0402` |
| A mesma key enquanto a primeira requisição ainda está em andamento | `409` `BRIDGE_PIPELINE_0401`. Tente de novo depois de uma pausa |
| A mesma key depois que a primeira requisição falhou | A requisição é executada de novo: uma requisição que falhou libera a sua key |

Uma key é mantida por **24 horas**; depois disso, a mesma key é executada como uma requisição nova. Todas as operações do workspace compartilham as keys, então não reutilize uma entre registros.

> [!WARNING]
>
> Se uma requisição for interrompida antes de terminar, a key dela pode continuar respondendo `409` `BRIDGE_PIPELINE_0401` por até 24 horas. Tente de novo com uma key nova. Envie `externalId` ao criar registros, para que uma nova tentativa com outra key nunca crie um segundo registro.

## Evite sobrescrever mudanças com expectedRevision

Cada registro tem um `revision` que sobe em um a cada mudança do registro. Envie o `revision` que você leu por último como `expectedRevision` no corpo de `PATCH`, `move` ou `reopen`. Se alguém mudou o registro nesse meio-tempo, a requisição falha com `409` `BRIDGE_PIPELINE_0101` e nada muda. `extra.currentRecord` é o registro como está agora: decida de novo a partir dele e tente outra vez com o `revision` dele.

`expectedRevision` é opcional. Sem ele, a mudança se aplica ao registro como o Bridge o lê, e uma mudança feita no mesmo momento ainda pode fazê-la falhar com o mesmo `409`.

```json PATCH theme={null}
{
  "expectedRevision": 2,
  "name": "Renamed"
}
```

```json 409 BRIDGE_PIPELINE_0101 theme={null}
{
  "title": "The pipeline record was modified by another operation",
  "status": 409,
  "detail": "Pipeline record 'record-1' is at revision 4, the write expected 2",
  "code": "BRIDGE_PIPELINE_0101",
  "extra": {
    "recordId": "record-1",
    "expectedRevision": 2,
    "currentRevision": 4,
    "currentRecord": {
      "id": "record-1",
      "stageId": "stage-proposal",
      "revision": 4
    }
  }
}
```

`extra.currentRecord` traz o registro completo, com os mesmos campos da resposta `201` acima; o exemplo mostra só três.

## Mova, feche e reabra

[Mova o registro](https://docs.bridge.new/pt-br/api-reference/pipeline-records-api/mover-um-registro-de-pipeline-para-outra-etapa.md) com o `stageId` de uma etapa da versão do pipeline que ele segue. Movê-lo para uma **etapa final o fecha**. Uma movimentação para uma etapa final pode levar `reasonId`, um dos motivos de fechamento ativos do pipeline, e um `reasonNote` de até 500 caracteres, que precisa de `reasonId`. O motivo de fechamento é opcional: sem ele, o registro é fechado com `closeReason: null`.

```bash theme={null}
curl --fail-with-body --request POST \
  "https://api-connect-us.bridge.new/bridge/api/v1/workspaces/$WORKSPACE_ID/records/$RECORD_ID/move" \
  --header "x-api-key: $BRIDGE_API_KEY" \
  --header "Idempotency-Key: erp-opp-981-won" \
  --header "Content-Type: application/json" \
  --data '{
    "stageId": "stage-won",
    "reasonId": "reason-price"
  }'
```

A resposta é `200` com o registro. Um registro fechado tem `state: "FINAL"`, `closedAt` e, quando a movimentação levou um, `closeReason` com o `id`, o `label` e a `note` do motivo.

| Problema | Resposta |
| - | - |
| O registro já está nessa etapa | `409` `BRIDGE_PIPELINE_0004` |
| O registro está fechado | `409` `BRIDGE_PIPELINE_0306`: reabra-o primeiro |
| A etapa não está na versão do pipeline do registro | `422` `BRIDGE_PIPELINE_0311`, com `errRecordStage` em `extra.errors` |
| Um motivo ou nota de fechamento em uma movimentação para uma etapa aberta | `422` `BRIDGE_PIPELINE_0311`, com `errReasonOnlyFinal` em `extra.errors` |
| O motivo de fechamento não existe, ou está desativado | `422` `BRIDGE_PIPELINE_0315`, ou `422` `BRIDGE_PIPELINE_0314` |
| A etapa exige um contato completo | `422` `BRIDGE_PIPELINE_0305`; `extra.missing` diz o que falta ao contato |

[Reabra um registro fechado](https://docs.bridge.new/pt-br/api-reference/pipeline-records-api/reabrir-um-registro-de-pipeline-fechado.md) para levá-lo de volta à etapa aberta em que estava antes de ser fechado; o motivo de fechamento é apagado. Quando o histórico dele não cita nenhuma etapa aberta da sua versão, o registro vai para a etapa inicial do pipeline. O corpo é opcional e só aceita `expectedRevision`. Reabrir um registro aberto falha com `409` `BRIDGE_PIPELINE_0307`.

## As ações de etapa são executadas em cada entrada

> [!WARNING]
>
> Uma etapa pode ter ações, como criar uma tarefa ou criar um registro em outro pipeline. Elas são executadas **cada vez que um registro entra na etapa**: quando é criado nela, quando é movido para ela e quando é reaberto nela. Isso inclui cada registro que você cria pela API, então uma importação em massa para uma etapa com ações as executa uma vez por registro. Confira as ações da etapa antes de uma importação.

As ações são executadas depois que a API responde; a resposta não espera por elas. Os resultados chegam como [eventos de webhook `pipeline_action.*`](https://docs.bridge.new/pt-br/webhooks/pipeline-records#stage-action-events).

## Erros e limites

* Todo erro responde um corpo `Problem`. Decida pelo `code`, não pelo `title`. Consulte os [códigos de erro de pipelines](https://docs.bridge.new/pt-br/error-codes.md#pipeline-error-codes) para cada código e o que fazer.
* As operações de pipelines consomem a mesma cota que o resto da API: **50 requisições a cada 5 segundos por workspace**. Consulte [Limites de requisições](https://docs.bridge.new/pt-br/rate-limits.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.