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

# Criar um registro de pipeline

> Cria um registro de um contato em um pipeline, como uma oportunidade de venda.

O contato é informado por exatamente um de `id`, `phone` ou `email` e precisa existir: nunca é criado (404
`BRIDGE_EXTERNAL_0001`). `pipelineId` assume por padrão o pipeline padrão do workspace e `stageId` a
etapa inicial do pipeline. Um `name` ausente ou em branco assume por padrão o nome completo do contato, depois seu
celular e depois seu e-mail. Só são aceitas etapas abertas, e só atributos de escopo `RECORD` da
versão atual do pipeline em `values` (um `null`, um texto em branco ou uma lista vazia é omitido); cada problema
encontrado é listado em `extra.errors` do 422
`BRIDGE_PIPELINE_0311`. Quando a etapa em que o registro começa exige um contato completo (nome, sobrenome,
celular e todo atributo personalizado obrigatório do workspace), um contato incompleto falha com 422
`BRIDGE_PIPELINE_0305`, cujo `extra.missing` indica o que falta. Um segundo registro com o mesmo `externalId`
no pipeline falha com 409 `BRIDGE_PIPELINE_0003`, cujo `extra.recordId` é o registro existente.

`Idempotency-Key` é obrigatório. Repetir com a mesma chave e o mesmo corpo responde 201 com o primeiro registro e
`Idempotent-Replayed: true`. A mesma chave com um corpo diferente falha com 422 `BRIDGE_PIPELINE_0402`, e
enquanto a primeira solicitação ainda está em andamento, com 409 `BRIDGE_PIPELINE_0401`. Quando a solicitação falha, a chave é
liberada e pode ser reutilizada. Se a primeira solicitação foi interrompida antes de terminar, sua chave continua respondendo 409
`BRIDGE_PIPELINE_0401` por até 24 horas: tente de novo com uma chave nova e envie `externalId` para que uma nova tentativa nunca
crie um segundo registro.



## OpenAPI

````yaml /pt-br/api-reference/openapi.yaml post /bridge/api/v1/workspaces/{workspaceId}/records
openapi: 3.1.0
info:
  title: Bridge API
  summary: Especificação da API do Bridge para gerenciar o sistema de chat.
  description: >-
    Especificação da API REST de integrações do Bridge para gerenciar contatos,
    conversas, mensagens, arquivos, atributos personalizados, canais de
    provedores, modelos, usuários internos e Agents.


    Os webhooks são documentados separadamente em
    https://docs.bridge.new/pt-br/webhooks; este OpenAPI contém apenas endpoints
    REST.


    **Arquitetura multiempresa**: as operações sobre recursos são limitadas a um
    workspace específico por workspaceId. A verificação de integridade não
    inclui um workspace no caminho.
  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 produção
security: []
paths:
  /bridge/api/v1/workspaces/{workspaceId}/records:
    post:
      tags:
        - Pipeline Records API
      summary: Criar um registro de pipeline
      description: >-
        Cria um registro de um contato em um pipeline, como uma oportunidade de
        venda.


        O contato é informado por exatamente um de `id`, `phone` ou `email` e
        precisa existir: nunca é criado (404

        `BRIDGE_EXTERNAL_0001`). `pipelineId` assume por padrão o pipeline
        padrão do workspace e `stageId` a

        etapa inicial do pipeline. Um `name` ausente ou em branco assume por
        padrão o nome completo do contato, depois seu

        celular e depois seu e-mail. Só são aceitas etapas abertas, e só
        atributos de escopo `RECORD` da

        versão atual do pipeline em `values` (um `null`, um texto em branco ou
        uma lista vazia é omitido); cada problema

        encontrado é listado em `extra.errors` do 422

        `BRIDGE_PIPELINE_0311`. Quando a etapa em que o registro começa exige um
        contato completo (nome, sobrenome,

        celular e todo atributo personalizado obrigatório do workspace), um
        contato incompleto falha com 422

        `BRIDGE_PIPELINE_0305`, cujo `extra.missing` indica o que falta. Um
        segundo registro com o mesmo `externalId`

        no pipeline falha com 409 `BRIDGE_PIPELINE_0003`, cujo `extra.recordId`
        é o registro existente.


        `Idempotency-Key` é obrigatório. Repetir com a mesma chave e o mesmo
        corpo responde 201 com o primeiro registro e

        `Idempotent-Replayed: true`. A mesma chave com um corpo diferente falha
        com 422 `BRIDGE_PIPELINE_0402`, e

        enquanto a primeira solicitação ainda está em andamento, com 409
        `BRIDGE_PIPELINE_0401`. Quando a solicitação falha, a chave é

        liberada e pode ser reutilizada. Se a primeira solicitação foi
        interrompida antes de terminar, sua chave continua respondendo 409

        `BRIDGE_PIPELINE_0401` por até 24 horas: tente de novo com uma chave
        nova e envie `externalId` para que uma nova tentativa nunca

        crie um 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 do workspace (UUID v4).
            examples:
              - b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234
            title: Workspaceid
          description: Identificador único do workspace (UUID v4).
        - name: Idempotency-Key
          in: header
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            description: >-
              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.
            examples:
              - erp-opp-981-create
            title: Idempotency-Key
          description: >-
            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.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePipelineRecordBody'
              description: Corpo da solicitação para criar um registro de pipeline.
      responses:
        '201':
          description: >-
            O registro foi criado, ou uma solicitação anterior com a mesma chave
            o criou.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineRecordResponse'
          headers:
            Location:
              description: URL do registro.
              schema:
                type: string
            Idempotent-Replayed:
              description: >-
                `true` quando o registro vem de uma solicitação anterior com a
                mesma chave.
              schema:
                type: string
                enum:
                  - 'true'
        '403':
          description: Acesso proibido
          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: Não 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: Conflito
          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: Conteúdo não processável
          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: Muitas solicitações
          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: >-
            O contato ao qual o registro pertence, informado por exatamente um
            de `id`, `phone` ou `email`.
        pipelineId:
          anyOf:
            - type: string
              maxLength: 255
              minLength: 1
            - type: 'null'
          title: Pipeline Identifier
          description: >-
            Pipeline em que o registro será criado. Por padrão, o pipeline
            padrão do workspace.
          examples:
            - 5d0b8f8e-3c1a-4a4e-9a57-2f6f3e1c9b10
        stageId:
          anyOf:
            - type: string
              maxLength: 255
              minLength: 1
            - type: 'null'
          title: Stage Identifier
          description: >-
            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.
          examples:
            - stage-new
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          description: >-
            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.
          examples:
            - Acme renewal 2027
        externalId:
          anyOf:
            - type: string
              maxLength: 255
              minLength: 1
            - type: 'null'
          title: External Identifier
          description: >-
            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.
          examples:
            - ERP-OPP-981
        values:
          additionalProperties: true
          type: object
          title: Values
          description: >-
            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.
          examples:
            - budget: 15000000
              closeDate: '2026-12-15'
              segment: Retail
      additionalProperties: false
      type: object
      required:
        - contact
      title: CreatePipelineRecordBody
      description: Corpo da solicitação para criar um registro de pipeline.
    PipelineRecordResponse:
      properties:
        id:
          type: string
          title: Identifier
          description: Identificador único do registro.
          examples:
            - 0d3c7f0e-5a43-5c0e-9f53-1f6a4b2e7d11
        pipelineId:
          type: string
          title: Pipeline Identifier
          description: Pipeline ao qual o registro pertence.
          examples:
            - 5d0b8f8e-3c1a-4a4e-9a57-2f6f3e1c9b10
        pipelineVersion:
          type: integer
          title: Pipeline Version
          description: Versão do pipeline que o registro segue.
          examples:
            - 3
        stageId:
          type: string
          title: Stage Identifier
          description: Etapa em que o registro está.
          examples:
            - stage-new
        state:
          $ref: '#/components/schemas/PipelineRecordState'
          title: State
          description: >-
            `OPEN` enquanto o registro está em uma etapa aberta, `FINAL` quando
            está em uma etapa final.
          examples:
            - OPEN
        name:
          type: string
          title: Name
          description: Nome do registro.
          examples:
            - Acme renewal 2027
        values:
          additionalProperties: true
          type: object
          title: Values
          description: Valores dos atributos do registro, indexados por id de atributo.
          examples:
            - budget: 15000000
              closeDate: '2026-12-15'
        contact:
          $ref: '#/components/schemas/RecordContactResponse'
          title: Contact
          description: O contato ao qual o registro pertence.
        ownerId:
          anyOf:
            - type: string
            - type: 'null'
          title: Owner Identifier
          description: >-
            Id do Usuário do Bridge responsável pelo registro. Resolva-o com
            `GET /users/{userId}`.
          examples:
            - null
        source:
          $ref: '#/components/schemas/PipelineRecordSource'
          title: Source
          description: >-
            Como o registro foi criado: `API`, `ADVISOR`, `INBOUND_SESSION` ou
            `FROM_PIPELINE`.
          examples:
            - API
        externalId:
          anyOf:
            - type: string
            - type: 'null'
          title: External Identifier
          description: O id do registro no seu sistema, quando foi criado com um.
          examples:
            - ERP-OPP-981
        revision:
          type: integer
          title: Revision
          description: Aumenta em um a cada vez que o registro muda.
          examples:
            - 1
        closeReason:
          anyOf:
            - $ref: '#/components/schemas/RecordCloseReasonResponse'
            - type: 'null'
          title: Close Reason
          description: >-
            Motivo com o qual o registro foi fechado; null enquanto está aberto
            ou quando foi fechado sem motivo.
        closedAt:
          anyOf:
            - type: string
            - type: 'null'
          title: Closed At
          description: >-
            Quando o registro chegou a uma etapa final; null enquanto está
            aberto.
          examples:
            - null
        createdAt:
          type: string
          title: Created At
          description: Quando o registro foi criado.
          examples:
            - '2026-11-11T15:00:00.000Z'
        updatedAt:
          type: string
          title: Updated At
          description: Quando o registro mudou pela ú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: >-
        Um registro de um pipeline, como uma oportunidade de venda de um
        contato.
    Problem:
      properties:
        title:
          type: string
          title: Title
          description: Resumo breve do tipo de problema.
        status:
          type: integer
          title: Status
          description: >-
            Código de status HTTP gerado pelo servidor de origem para esta
            ocorrência do problema.
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
          description: Explicação específica desta ocorrência do problema.
        instance:
          anyOf:
            - type: string
            - type: 'null'
          title: Instance
          description: Referência URI que identifica esta ocorrência do problema.
        traceId:
          anyOf:
            - type: string
            - type: 'null'
          title: Traceid
          description: ID de rastreamento para depuração.
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: >-
            Código para identificar o erro; consulte a página de códigos de erro
            para mais detalhes.
        errors:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          title: Errors
          description: Lista de detalhes dos erros.
        extra:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Extra
          description: Informações adicionais sobre o problema.
      type: object
      required:
        - title
        - status
      title: Problem
      description: Objeto que representa o corpo de uma resposta Problem.
    RecordContactRequest:
      properties:
        id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Identifier
          description: Id do contato, conforme retornado pela API de Contatos.
          examples:
            - 4e362e2b-67b2-4a7e-a9df-e9ecf9141be8
        phone:
          anyOf:
            - type: string
              maxLength: 320
              minLength: 1
            - type: 'null'
          title: Phone
          description: >-
            Celular do contato, interpretado como o `GET /contacts/lookup` o
            interpreta: um número sem código de país é interpretado no país
            padrão do workspace.
          examples:
            - '+573001234567'
        email:
          anyOf:
            - type: string
              maxLength: 320
              minLength: 1
            - type: 'null'
          title: Email
          description: >-
            E-mail do contato, interpretado como o `GET /contacts/lookup` o
            interpreta.
          examples:
            - john.doe@example.com
      additionalProperties: false
      type: object
      title: RecordContactRequest
      description: >-
        O contato ao qual o registro pertence, informado por exatamente um de
        seus identificadores. O contato nunca é criado.
    PipelineRecordState:
      type: string
      enum:
        - OPEN
        - FINAL
      title: PipelineRecordState
    RecordContactResponse:
      properties:
        id:
          type: string
          title: Identifier
          description: Id do contato. Resolva-o com `GET /contacts/{contactId}`.
          examples:
            - 4e362e2b-67b2-4a7e-a9df-e9ecf9141be8
      type: object
      required:
        - id
      title: RecordContactResponse
      description: O contato ao qual um registro pertence.
    PipelineRecordSource:
      type: string
      enum:
        - ADVISOR
        - API
        - INBOUND_SESSION
        - FROM_PIPELINE
      title: PipelineRecordSource
    RecordCloseReasonResponse:
      properties:
        id:
          type: string
          title: Identifier
          description: Id do motivo de fechamento, conforme `GET /pipelines/{pipelineId}`.
          examples:
            - reason-price
        label:
          type: string
          title: Label
          description: Nome do motivo de fechamento quando o registro foi fechado.
          examples:
            - Price too high
        note:
          anyOf:
            - type: string
            - type: 'null'
          title: Note
          description: Texto livre escrito quando o registro foi fechado.
          examples:
            - null
      type: object
      required:
        - id
        - label
      title: RecordCloseReasonResponse
      description: O motivo com o qual um registro fechado foi fechado.
  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.