> ## 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.

# Crea y mueve registros de pipeline

> Crea registros de pipeline para contactos existentes, reintenta con seguridad con Idempotency-Key, evita perder cambios con expectedRevision y cierra o reabre registros.

Un registro de pipeline sigue un trabajo con un contacto, como una oportunidad de venta, a lo largo de las etapas de un pipeline. Usa esta receta para llevar los registros de tu sistema a un pipeline de Bridge: créalos, cambia sus valores, muévelos entre etapas, ciérralos con un motivo y reábrelos. Para recibir los cambios hechos en Bridge, suscríbete a los [eventos de registros de pipeline](https://docs.bridge.new/es/webhooks/pipeline-records.md).

## Antes de empezar

* Obtén una API Key de servidor en [Autenticación](https://docs.bridge.new/es/credentials.md) y envíala en `x-api-key`, como en cualquier otra operación. El `workspaceId` de la ruta debe ser el workspace de esa key. Cualquier otro workspace se rechaza con `403` `BRIDGE_CORE_0301`, y no se lee ni se escribe nada.
* Los pipelines deben estar habilitados para el workspace. Si no, todas las operaciones responden `403` `BRIDGE_PIPELINE_0301`.
* [Obtén el pipeline](https://docs.bridge.new/es/api-reference/pipelines-api/obtener-un-pipeline-con-sus-etapas-y-atributos.md) en el que escribes. Lista los valores de `stageId`, los ids de atributo que usas como claves de `values` y los motivos de cierre activos. [Lista los pipelines](https://docs.bridge.new/es/api-reference/pipelines-api/listar-los-pipelines-de-un-workspace.md) para encontrar su id.

```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"
}
```

## Las operaciones

| Tu objetivo | Operación | `Idempotency-Key` | `expectedRevision` |
| - | - | - | - |
| Crear un registro | [`POST .../records`](https://docs.bridge.new/es/api-reference/pipeline-records-api/crear-un-registro-de-pipeline) | Obligatoria | No se acepta |
| Buscar registros por tu id, un contacto o un pipeline | [`GET .../records`](https://docs.bridge.new/es/api-reference/pipeline-records-api/listar-registros-de-pipeline) | No se acepta | No se acepta |
| Leer un registro | [`GET .../records/{recordId}`](https://docs.bridge.new/es/api-reference/pipeline-records-api/obtener-un-registro-de-pipeline) | No se acepta | No se acepta |
| Cambiar su nombre o sus valores | [`PATCH .../records/{recordId}`](https://docs.bridge.new/es/api-reference/pipeline-records-api/actualizar-un-registro-de-pipeline) | No se acepta | Opcional |
| Moverlo a otra etapa, o cerrarlo | [`POST .../records/{recordId}/move`](https://docs.bridge.new/es/api-reference/pipeline-records-api/mover-un-registro-de-pipeline-a-otra-etapa) | Obligatoria | Opcional |
| Reabrir un registro cerrado | [`POST .../records/{recordId}/reopen`](https://docs.bridge.new/es/api-reference/pipeline-records-api/reabrir-un-registro-de-pipeline-cerrado) | Obligatoria | Opcional |

`...` representa `/bridge/api/v1/workspaces/{workspaceId}`, en el host de la API REST `https://api-connect-us.bridge.new`.

## Crea un registro

Indica el contacto con exactamente uno de `contact.id`, `contact.phone` o `contact.email`. Bridge encuentra el contacto igual que la [búsqueda de contactos](https://docs.bridge.new/es/api-reference/contacts-api/obtener-contacto-por-un-identificador.md); un contacto fusionado con otro se resuelve al contacto que lo reemplazó. El contacto nunca se crea: si no existe, la solicitud falla con `404` `BRIDGE_EXTERNAL_0001`, así que [crea el contacto](https://docs.bridge.new/es/api-reference/contacts-api/crear-contacto.md) primero y reintenta.

Sin `pipelineId`, el registro va al pipeline predeterminado del workspace, y sin `stageId`, a la etapa inicial del pipeline. Al crear no se acepta una etapa final. Un pipeline configurado para no aceptar registros de la API rechaza la creación con `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"
    }
  }'
```

Un registro creado responde `201` con un header `Location` y el registro. Guarda su `id` y su `revision`:

```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"
  }
}
```

### Vincula el registro con tu propio id

Envía `externalId` con el id que tiene el registro en tu sistema. Un pipeline tiene **un registro por `externalId`**: una segunda creación con el mismo `externalId` en el mismo pipeline falla con `409` `BRIDGE_PIPELINE_0003`, y `extra.recordId` es el registro que ya lo tiene. Lee ese registro en vez de crear otro. Para encontrarlo después, [lista los registros](https://docs.bridge.new/es/api-reference/pipeline-records-api/listar-registros-de-pipeline.md) con `externalId` (y `pipelineId` cuando no es el pipeline predeterminado).

Bridge elige el id del registro; el cuerpo de la solicitud no tiene un campo para fijarlo.

```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"
  }
}
```

### Un registro abierto por contacto

Un pipeline puede configurarse en Bridge para que un contacto tenga un solo registro abierto a la vez. En ese pipeline, crear un registro para un contacto que ya tiene uno abierto falla con `409` `BRIDGE_PIPELINE_0318`, y `extra.openRecordId` es ese registro abierto: trabaja sobre él. Los registros cerrados no cuentan, así que un contacto puede empezar un registro nuevo cuando el anterior está cerrado. Reabrir un registro falla de la misma forma cuando el contacto tiene otro registro abierto en el 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"
  }
}
```

## Reintenta con seguridad con Idempotency-Key

`POST .../records`, `POST .../move` y `POST .../reopen` exigen un header `Idempotency-Key` de 1 a 255 caracteres. Usa una key por cada cambio que quieras hacer y envía la misma key cuando reintentes ese cambio.

| Envías | Bridge responde |
| - | - |
| La misma key y el mismo cuerpo, después de que terminó la primera solicitud | El mismo status (`201` o `200`) con el header `Idempotent-Replayed: true`. El cuerpo es el registro **como está ahora**, así que puede mostrar cambios posteriores |
| La misma key con otro cuerpo, o en otro registro u operación | `422` `BRIDGE_PIPELINE_0402` |
| La misma key mientras la primera solicitud sigue en curso | `409` `BRIDGE_PIPELINE_0401`. Reintenta después de una pausa |
| La misma key después de que falló la primera solicitud | La solicitud se ejecuta de nuevo: una solicitud fallida libera su key |

Una key se guarda **24 horas**; después, la misma key se ejecuta como una solicitud nueva. Todas las operaciones del workspace comparten las keys, así que no reutilices una entre registros.

> [!WARNING]
>
> Si una solicitud se corta antes de terminar, su key puede seguir respondiendo `409` `BRIDGE_PIPELINE_0401` hasta por 24 horas. Reintenta con una key nueva. Envía `externalId` cuando crees registros, para que un reintento con una key nueva nunca cree un segundo registro.

## Evita sobrescribir cambios con expectedRevision

Cada registro tiene un `revision` que sube en uno cada vez que el registro cambia. Envía el `revision` que leíste por última vez como `expectedRevision` en el cuerpo de `PATCH`, `move` o `reopen`. Si alguien cambió el registro mientras tanto, la solicitud falla con `409` `BRIDGE_PIPELINE_0101` y no cambia nada. `extra.currentRecord` es el registro como está ahora: decide de nuevo a partir de él y reintenta con su `revision`.

`expectedRevision` es opcional. Sin él, el cambio se aplica al registro tal como Bridge lo lee, y un cambio hecho en el mismo momento todavía puede hacerlo fallar con el mismo `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` trae el registro completo, con los mismos campos que la respuesta `201` de arriba; el ejemplo muestra solo tres.

## Mueve, cierra y reabre

[Mueve el registro](https://docs.bridge.new/es/api-reference/pipeline-records-api/mover-un-registro-de-pipeline-a-otra-etapa.md) con el `stageId` de una etapa de la versión del pipeline que sigue. Moverlo a una **etapa final lo cierra**. Un movimiento a una etapa final puede llevar `reasonId`, uno de los motivos de cierre activos del pipeline, y un `reasonNote` de hasta 500 caracteres, que necesita `reasonId`. El motivo de cierre es opcional: sin él, el registro se cierra con `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"
  }'
```

La respuesta es `200` con el registro. Un registro cerrado tiene `state: "FINAL"`, `closedAt` y, cuando el movimiento llevó uno, `closeReason` con el `id`, `label` y `note` del motivo.

| Problema | Respuesta |
| - | - |
| El registro ya está en esa etapa | `409` `BRIDGE_PIPELINE_0004` |
| El registro está cerrado | `409` `BRIDGE_PIPELINE_0306`: reábrelo primero |
| La etapa no está en la versión del pipeline del registro | `422` `BRIDGE_PIPELINE_0311`, con `errRecordStage` en `extra.errors` |
| Un motivo o nota de cierre en un movimiento a una etapa abierta | `422` `BRIDGE_PIPELINE_0311`, con `errReasonOnlyFinal` en `extra.errors` |
| El motivo de cierre no existe, o está retirado | `422` `BRIDGE_PIPELINE_0315`, o `422` `BRIDGE_PIPELINE_0314` |
| La etapa exige un contacto completo | `422` `BRIDGE_PIPELINE_0305`; `extra.missing` dice qué le falta al contacto |

[Reabre un registro cerrado](https://docs.bridge.new/es/api-reference/pipeline-records-api/reabrir-un-registro-de-pipeline-cerrado.md) para devolverlo a la etapa abierta en la que estaba antes de cerrarse; su motivo de cierre se borra. Cuando su historial no nombra ninguna etapa abierta de su versión, el registro va a la etapa inicial del pipeline. El cuerpo es opcional y solo acepta `expectedRevision`. Reabrir un registro abierto falla con `409` `BRIDGE_PIPELINE_0307`.

## Las acciones de etapa corren en cada entrada

> [!WARNING]
>
> Una etapa puede tener acciones, como crear una tarea o crear un registro en otro pipeline. Corren **cada vez que un registro entra a la etapa**: cuando se crea en ella, cuando se mueve a ella y cuando se reabre en ella. Eso incluye cada registro que creas con la API, así que una importación masiva a una etapa con acciones las corre una vez por registro. Revisa las acciones de la etapa antes de una importación.

Las acciones corren después de que la API responde; la respuesta no las espera. Sus resultados llegan como [eventos de webhook `pipeline_action.*`](https://docs.bridge.new/es/webhooks/pipeline-records#stage-action-events).

## Errores y límites

* Todo error responde un cuerpo `Problem`. Decide según `code`, no según `title`. Consulta los [códigos de error de pipelines](https://docs.bridge.new/es/error-codes.md#pipeline-error-codes) para cada código y qué hacer.
* Las operaciones de pipelines consumen el mismo presupuesto que el resto de la API: **50 solicitudes cada 5 segundos por workspace**. Consulta [Límites de solicitudes](https://docs.bridge.new/es/rate-limits.md).


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