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

# Crear un registro de pipeline

> Crea un registro de un contacto en un pipeline, como una oportunidad de venta.

El contacto se indica con exactamente uno de `id`, `phone` o `email` y debe existir: nunca se crea (404
`BRIDGE_EXTERNAL_0001`). `pipelineId` toma por defecto el pipeline predeterminado del workspace y `stageId` la
etapa inicial del pipeline. Un `name` ausente o vacío toma por defecto el nombre completo del contacto, luego su
celular y luego su correo electrónico. Solo se aceptan etapas abiertas, y solo atributos de alcance `RECORD` de la
versión actual del pipeline en `values` (un `null`, un texto vacío o una lista vacía se omite); cada problema
encontrado se lista en `extra.errors` del 422
`BRIDGE_PIPELINE_0311`. Cuando la etapa en la que empieza el registro exige un contacto completo (nombre, apellido,
celular y cada atributo personalizado obligatorio del workspace), uno incompleto falla con 422
`BRIDGE_PIPELINE_0305`, cuyo `extra.missing` indica lo que le falta. Un segundo registro con el mismo `externalId`
en el pipeline falla con 409 `BRIDGE_PIPELINE_0003`, cuyo `extra.recordId` es el registro existente.

`Idempotency-Key` es obligatorio. Reintentar con la misma clave y el mismo cuerpo responde 201 con el primer registro y
`Idempotent-Replayed: true`. La misma clave con un cuerpo distinto falla con 422 `BRIDGE_PIPELINE_0402`, y
mientras la primera solicitud sigue en curso, con 409 `BRIDGE_PIPELINE_0401`. Cuando la solicitud falla, la clave se
libera y puede reintentarse. Si la primera solicitud se cortó antes de terminar, su clave sigue respondiendo 409
`BRIDGE_PIPELINE_0401` hasta por 24 horas: reintenta con una clave nueva y envía `externalId` para que un reintento nunca
cree un segundo registro.



## OpenAPI

````yaml /es/api-reference/openapi.yaml post /bridge/api/v1/workspaces/{workspaceId}/records
openapi: 3.1.0
info:
  title: Bridge API
  summary: Especificación de la API de Bridge para gestionar el sistema de chat.
  description: >-
    Especificación de la API REST de integraciones de Bridge para gestionar
    contactos, conversaciones, mensajes, archivos, atributos personalizados,
    canales de proveedores, plantillas, usuarios internos y Agents.


    Los webhooks se documentan por separado en
    https://docs.bridge.new/es/webhooks; este OpenAPI contiene únicamente
    endpoints REST.


    **Arquitectura multiempresa**: las operaciones sobre recursos se limitan a
    un workspace específico mediante workspaceId. La comprobación de estado no
    incluye un workspace en su ruta.
  termsOfService: https://www.sainapsis.com/legal/terms-of-service
  contact:
    name: Bridge Support
    url: https://app.bridge.new/
    email: support@sainapsis.com
  license:
    name: MIT License
    url: https://spdx.org/licenses/MIT.html
  version: 1.0.0
servers:
  - url: https://api-connect-us.bridge.new
    description: Servidor de producción
security: []
paths:
  /bridge/api/v1/workspaces/{workspaceId}/records:
    post:
      tags:
        - Pipeline Records API
      summary: Crear un registro de pipeline
      description: >-
        Crea un registro de un contacto en un pipeline, como una oportunidad de
        venta.


        El contacto se indica con exactamente uno de `id`, `phone` o `email` y
        debe existir: nunca se crea (404

        `BRIDGE_EXTERNAL_0001`). `pipelineId` toma por defecto el pipeline
        predeterminado del workspace y `stageId` la

        etapa inicial del pipeline. Un `name` ausente o vacío toma por defecto
        el nombre completo del contacto, luego su

        celular y luego su correo electrónico. Solo se aceptan etapas abiertas,
        y solo atributos de alcance `RECORD` de la

        versión actual del pipeline en `values` (un `null`, un texto vacío o una
        lista vacía se omite); cada problema

        encontrado se lista en `extra.errors` del 422

        `BRIDGE_PIPELINE_0311`. Cuando la etapa en la que empieza el registro
        exige un contacto completo (nombre, apellido,

        celular y cada atributo personalizado obligatorio del workspace), uno
        incompleto falla con 422

        `BRIDGE_PIPELINE_0305`, cuyo `extra.missing` indica lo que le falta. Un
        segundo registro con el mismo `externalId`

        en el pipeline falla con 409 `BRIDGE_PIPELINE_0003`, cuyo
        `extra.recordId` es el registro existente.


        `Idempotency-Key` es obligatorio. Reintentar con la misma clave y el
        mismo cuerpo responde 201 con el primer registro y

        `Idempotent-Replayed: true`. La misma clave con un cuerpo distinto falla
        con 422 `BRIDGE_PIPELINE_0402`, y

        mientras la primera solicitud sigue en curso, con 409
        `BRIDGE_PIPELINE_0401`. Cuando la solicitud falla, la clave se

        libera y puede reintentarse. Si la primera solicitud se cortó antes de
        terminar, su clave sigue respondiendo 409

        `BRIDGE_PIPELINE_0401` hasta por 24 horas: reintenta con una clave nueva
        y envía `externalId` para que un reintento nunca

        cree un segundo registro.
      operationId: >-
        create_pipeline_record_bridge_api_v1_workspaces__workspaceId__records_post
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            format: uuid
            description: Identificador único del workspace (UUID v4).
            examples:
              - b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234
            title: Workspaceid
          description: Identificador único del workspace (UUID v4).
        - name: Idempotency-Key
          in: header
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            description: >-
              Una clave que eliges por cada registro a crear, como el id de
              operación de tu sistema. Envía la misma clave cuando reintentes la
              solicitud: durante 24 horas responde con el registro que creó la
              primera solicitud.
            examples:
              - erp-opp-981-create
            title: Idempotency-Key
          description: >-
            Una clave que eliges por cada registro a crear, como el id de
            operación de tu sistema. Envía la misma clave cuando reintentes la
            solicitud: durante 24 horas responde con el registro que creó la
            primera solicitud.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePipelineRecordBody'
              description: Cuerpo de la solicitud para crear un registro de pipeline.
      responses:
        '201':
          description: >-
            El registro se creó, o lo creó una solicitud anterior con la misma
            clave.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineRecordResponse'
          headers:
            Location:
              description: URL del registro.
              schema:
                type: string
            Idempotent-Replayed:
              description: >-
                `true` cuando el registro proviene de una solicitud anterior con
                la misma clave.
              schema:
                type: string
                enum:
                  - 'true'
        '403':
          description: Acceso prohibido
          content:
            application/json:
              examples:
                FORBIDDEN:
                  value:
                    title: Forbidden
                    status: 403
                    code: BRIDGE_CORE_0301
                PIPELINES_DISABLED:
                  value:
                    title: Pipelines Disabled
                    status: 403
                    code: BRIDGE_PIPELINE_0301
                PIPELINE_ENTRY_DISABLED:
                  value:
                    title: Pipeline Entry Disabled
                    status: 403
                    code: BRIDGE_PIPELINE_0317
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: No encontrado
          content:
            application/json:
              examples:
                WORKSPACE_NOT_FOUND:
                  value:
                    title: Workspace Not Found
                    status: 404
                    code: BRIDGE_WORKSPACE_0001
                EXTERNAL_USER_NOT_FOUND:
                  value:
                    title: External User Not Found
                    status: 404
                    code: BRIDGE_EXTERNAL_0001
                PIPELINE_NOT_FOUND:
                  value:
                    title: Pipeline Not Found
                    status: 404
                    code: BRIDGE_PIPELINE_0201
              schema:
                $ref: '#/components/schemas/Problem'
        '409':
          description: Conflicto
          content:
            application/json:
              examples:
                PIPELINE_RECORD_EXTERNAL_ID_TAKEN:
                  value:
                    title: Pipeline Record External Id Taken
                    status: 409
                    code: BRIDGE_PIPELINE_0003
                IDEMPOTENCY_REQUEST_IN_PROGRESS:
                  value:
                    title: Idempotency Request In Progress
                    status: 409
                    code: BRIDGE_PIPELINE_0401
              schema:
                $ref: '#/components/schemas/Problem'
        '422':
          description: Contenido no procesable
          content:
            application/json:
              examples:
                INVALID_FIELD_FORMAT:
                  value:
                    title: Invalid Field Format
                    status: 422
                    code: BRIDGE_CORE_0101
                PIPELINE_RECORD_VALIDATION_FAILED:
                  value:
                    title: Pipeline Record Validation Failed
                    status: 422
                    code: BRIDGE_PIPELINE_0311
                CONTACT_INCOMPLETE:
                  value:
                    title: Contact Incomplete
                    status: 422
                    code: BRIDGE_PIPELINE_0305
                IDEMPOTENCY_KEY_REUSED:
                  value:
                    title: Idempotency Key Reused
                    status: 422
                    code: BRIDGE_PIPELINE_0402
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: Demasiadas solicitudes
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                WORKSPACE_BUDGET_EXHAUSTED:
                  value:
                    title: Too Many Requests
                    status: 429
                    code: BRIDGE_RATE_LIMIT_0001
      security:
        - x-api-key: []
components:
  schemas:
    CreatePipelineRecordBody:
      properties:
        contact:
          $ref: '#/components/schemas/RecordContactRequest'
          title: Contact
          description: >-
            El contacto al que pertenece el registro, indicado con exactamente
            uno de `id`, `phone` o `email`.
        pipelineId:
          anyOf:
            - type: string
              maxLength: 255
              minLength: 1
            - type: 'null'
          title: Pipeline Identifier
          description: >-
            Pipeline en el que se crea el registro. Por defecto, el pipeline
            predeterminado del workspace.
          examples:
            - 5d0b8f8e-3c1a-4a4e-9a57-2f6f3e1c9b10
        stageId:
          anyOf:
            - type: string
              maxLength: 255
              minLength: 1
            - type: 'null'
          title: Stage Identifier
          description: >-
            Etapa en la que empieza el registro. Por defecto, la etapa inicial
            del pipeline; se rechaza una etapa final. Se aplican los requisitos
            de la etapa, como un contacto completo.
          examples:
            - stage-new
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          description: >-
            Nombre del registro, de hasta 200 caracteres. Si falta o está vacío,
            se usa el nombre completo del contacto, luego su celular y luego su
            correo electrónico.
          examples:
            - Acme renewal 2027
        externalId:
          anyOf:
            - type: string
              maxLength: 255
              minLength: 1
            - type: 'null'
          title: External Identifier
          description: >-
            Id del registro en tu sistema, único por pipeline. Un segundo
            registro con el mismo `externalId` en el mismo pipeline se rechaza
            con 409 y el id del registro existente.
          examples:
            - ERP-OPP-981
        values:
          additionalProperties: true
          type: object
          title: Values
          description: >-
            Valores de los atributos del registro, indexados por id de atributo.
            Solo se aceptan atributos de alcance `RECORD` de la versión actual
            del pipeline, cada uno validado según su tipo (`TEXT` hasta 2000
            caracteres); un valor `null`, un texto vacío y una lista vacía se
            omiten.
          examples:
            - budget: 15000000
              closeDate: '2026-12-15'
              segment: Retail
      additionalProperties: false
      type: object
      required:
        - contact
      title: CreatePipelineRecordBody
      description: Cuerpo de la solicitud para crear un registro de pipeline.
    PipelineRecordResponse:
      properties:
        id:
          type: string
          title: Identifier
          description: Identificador único del registro.
          examples:
            - 0d3c7f0e-5a43-5c0e-9f53-1f6a4b2e7d11
        pipelineId:
          type: string
          title: Pipeline Identifier
          description: Pipeline al que pertenece el registro.
          examples:
            - 5d0b8f8e-3c1a-4a4e-9a57-2f6f3e1c9b10
        pipelineVersion:
          type: integer
          title: Pipeline Version
          description: Versión del pipeline que sigue el registro.
          examples:
            - 3
        stageId:
          type: string
          title: Stage Identifier
          description: Etapa en la que está el registro.
          examples:
            - stage-new
        state:
          $ref: '#/components/schemas/PipelineRecordState'
          title: State
          description: >-
            `OPEN` mientras el registro está en una etapa abierta, `FINAL`
            cuando está en una etapa final.
          examples:
            - OPEN
        name:
          type: string
          title: Name
          description: Nombre del registro.
          examples:
            - Acme renewal 2027
        values:
          additionalProperties: true
          type: object
          title: Values
          description: Valores de los atributos del registro, indexados por id de atributo.
          examples:
            - budget: 15000000
              closeDate: '2026-12-15'
        contact:
          $ref: '#/components/schemas/RecordContactResponse'
          title: Contact
          description: El contacto al que pertenece el registro.
        ownerId:
          anyOf:
            - type: string
            - type: 'null'
          title: Owner Identifier
          description: >-
            Id del Usuario de Bridge propietario del registro. Resuélvelo con
            `GET /users/{userId}`.
          examples:
            - null
        source:
          $ref: '#/components/schemas/PipelineRecordSource'
          title: Source
          description: >-
            Cómo se creó el registro: `API`, `ADVISOR`, `INBOUND_SESSION` o
            `FROM_PIPELINE`.
          examples:
            - API
        externalId:
          anyOf:
            - type: string
            - type: 'null'
          title: External Identifier
          description: El id del registro en tu sistema, cuando se creó con uno.
          examples:
            - ERP-OPP-981
        revision:
          type: integer
          title: Revision
          description: Aumenta en uno cada vez que el registro cambia.
          examples:
            - 1
        closeReason:
          anyOf:
            - $ref: '#/components/schemas/RecordCloseReasonResponse'
            - type: 'null'
          title: Close Reason
          description: >-
            Motivo con el que se cerró el registro; null mientras está abierto o
            cuando se cerró sin motivo.
        closedAt:
          anyOf:
            - type: string
            - type: 'null'
          title: Closed At
          description: >-
            Cuándo el registro llegó a una etapa final; null mientras está
            abierto.
          examples:
            - null
        createdAt:
          type: string
          title: Created At
          description: Cuándo se creó el registro.
          examples:
            - '2026-11-11T15:00:00.000Z'
        updatedAt:
          type: string
          title: Updated At
          description: Cuándo cambió el registro por última vez.
          examples:
            - '2026-11-11T15:00:00.000Z'
      type: object
      required:
        - id
        - pipelineId
        - pipelineVersion
        - stageId
        - state
        - name
        - contact
        - source
        - revision
        - createdAt
        - updatedAt
      title: PipelineRecordResponse
      description: >-
        Un registro de un pipeline, como una oportunidad de venta de un
        contacto.
    Problem:
      properties:
        title:
          type: string
          title: Title
          description: Resumen breve del tipo de problema.
        status:
          type: integer
          title: Status
          description: >-
            Código de estado HTTP generado por el servidor de origen para esta
            instancia del problema.
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
          description: Explicación específica de esta instancia del problema.
        instance:
          anyOf:
            - type: string
            - type: 'null'
          title: Instance
          description: Referencia URI que identifica esta instancia del problema.
        traceId:
          anyOf:
            - type: string
            - type: 'null'
          title: Traceid
          description: ID de seguimiento para depuración.
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: >-
            Código para identificar el error; consulta la página de códigos de
            error para más detalles.
        errors:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          title: Errors
          description: Lista de detalles de errores.
        extra:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Extra
          description: Información adicional sobre el problema.
      type: object
      required:
        - title
        - status
      title: Problem
      description: Objeto que representa el cuerpo de una respuesta Problem.
    RecordContactRequest:
      properties:
        id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Identifier
          description: Id del contacto, tal como lo devuelve la API de Contactos.
          examples:
            - 4e362e2b-67b2-4a7e-a9df-e9ecf9141be8
        phone:
          anyOf:
            - type: string
              maxLength: 320
              minLength: 1
            - type: 'null'
          title: Phone
          description: >-
            Celular del contacto, interpretado como lo hace `GET
            /contacts/lookup`: un número sin código de país se interpreta en el
            país predeterminado del workspace.
          examples:
            - '+573001234567'
        email:
          anyOf:
            - type: string
              maxLength: 320
              minLength: 1
            - type: 'null'
          title: Email
          description: >-
            Correo electrónico del contacto, interpretado como lo hace `GET
            /contacts/lookup`.
          examples:
            - john.doe@example.com
      additionalProperties: false
      type: object
      title: RecordContactRequest
      description: >-
        El contacto al que pertenece el registro, indicado con exactamente uno
        de sus identificadores. El contacto nunca se crea.
    PipelineRecordState:
      type: string
      enum:
        - OPEN
        - FINAL
      title: PipelineRecordState
    RecordContactResponse:
      properties:
        id:
          type: string
          title: Identifier
          description: Id del contacto. Resuélvelo con `GET /contacts/{contactId}`.
          examples:
            - 4e362e2b-67b2-4a7e-a9df-e9ecf9141be8
      type: object
      required:
        - id
      title: RecordContactResponse
      description: El contacto al que pertenece un registro.
    PipelineRecordSource:
      type: string
      enum:
        - ADVISOR
        - API
        - INBOUND_SESSION
        - FROM_PIPELINE
      title: PipelineRecordSource
    RecordCloseReasonResponse:
      properties:
        id:
          type: string
          title: Identifier
          description: Id del motivo de cierre, según `GET /pipelines/{pipelineId}`.
          examples:
            - reason-price
        label:
          type: string
          title: Label
          description: Nombre del motivo de cierre cuando se cerró el registro.
          examples:
            - Price too high
        note:
          anyOf:
            - type: string
            - type: 'null'
          title: Note
          description: Texto libre escrito cuando se cerró el registro.
          examples:
            - null
      type: object
      required:
        - id
        - label
      title: RecordCloseReasonResponse
      description: El motivo con el que se cerró un registro cerrado.
  securitySchemes:
    x-api-key:
      type: apiKey
      description: Copy the API key as provided by the Bridge Console.
      in: header
      name: x-api-key

````

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