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

# Create a pipeline record

> Create a record of a contact in a pipeline, such as a sales opportunity.

The contact is given by exactly one of `id`, `phone` or `email` and must exist: it is never created (404
`BRIDGE_EXTERNAL_0001`). `pipelineId` defaults to the workspace's default pipeline and `stageId` to the
pipeline's initial stage. A missing or blank `name` defaults to the contact's full name, then its cellphone,
then its email. Only open stages are accepted, and only `RECORD`-scope attributes of the pipeline's current
version in `values` (a `null`, a blank text or an empty list is left out); every problem found is listed in `extra.errors` of the 422
`BRIDGE_PIPELINE_0311`. When the stage the record starts in requires a complete contact (first name, last name,
cellphone and every required custom attribute of the workspace), an incomplete one fails with 422
`BRIDGE_PIPELINE_0305`, whose `extra.missing` names what it lacks. A second record with the same `externalId`
in the pipeline fails with 409 `BRIDGE_PIPELINE_0003`, whose `extra.recordId` is the existing record.

`Idempotency-Key` is required. Retrying with the same key and body answers 201 with the first record and
`Idempotent-Replayed: true`. The same key with a different body fails with 422 `BRIDGE_PIPELINE_0402`, and
while the first request is still running with 409 `BRIDGE_PIPELINE_0401`. When the request fails, the key is
freed and can be retried. If the first request was cut off before it finished, its key keeps answering 409
`BRIDGE_PIPELINE_0401` for up to 24 hours: retry with a new key, and send `externalId` so that a retry never
creates a second record.



## OpenAPI

````yaml /api-reference/openapi.yaml post /bridge/api/v1/workspaces/{workspaceId}/records
openapi: 3.1.0
info:
  title: Bridge API
  summary: Bridge API specification for chat system management.
  description: >-
    Bridge REST Integrations API specification for managing contacts,
    conversations, messages, files, custom attributes, provider channels,
    templates, internal users, and Agents.


    Webhooks are documented separately at https://docs.bridge.new/webhooks; this
    OpenAPI contains REST endpoints only.


    **Multi-Tenant Architecture**: Resource operations are scoped to a specific
    workspace using workspaceId. The health check does not have a workspace
    path.
  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: Production server
security: []
paths:
  /bridge/api/v1/workspaces/{workspaceId}/records:
    post:
      tags:
        - Pipeline Records API
      summary: Create a pipeline record
      description: >-
        Create a record of a contact in a pipeline, such as a sales opportunity.


        The contact is given by exactly one of `id`, `phone` or `email` and must
        exist: it is never created (404

        `BRIDGE_EXTERNAL_0001`). `pipelineId` defaults to the workspace's
        default pipeline and `stageId` to the

        pipeline's initial stage. A missing or blank `name` defaults to the
        contact's full name, then its cellphone,

        then its email. Only open stages are accepted, and only `RECORD`-scope
        attributes of the pipeline's current

        version in `values` (a `null`, a blank text or an empty list is left
        out); every problem found is listed in `extra.errors` of the 422

        `BRIDGE_PIPELINE_0311`. When the stage the record starts in requires a
        complete contact (first name, last name,

        cellphone and every required custom attribute of the workspace), an
        incomplete one fails with 422

        `BRIDGE_PIPELINE_0305`, whose `extra.missing` names what it lacks. A
        second record with the same `externalId`

        in the pipeline fails with 409 `BRIDGE_PIPELINE_0003`, whose
        `extra.recordId` is the existing record.


        `Idempotency-Key` is required. Retrying with the same key and body
        answers 201 with the first record and

        `Idempotent-Replayed: true`. The same key with a different body fails
        with 422 `BRIDGE_PIPELINE_0402`, and

        while the first request is still running with 409
        `BRIDGE_PIPELINE_0401`. When the request fails, the key is

        freed and can be retried. If the first request was cut off before it
        finished, its key keeps answering 409

        `BRIDGE_PIPELINE_0401` for up to 24 hours: retry with a new key, and
        send `externalId` so that a retry never

        creates a second record.
      operationId: >-
        create_pipeline_record_bridge_api_v1_workspaces__workspaceId__records_post
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            format: uuid
            description: Unique identifier of the workspace (UUID v4).
            examples:
              - b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234
            title: Workspaceid
          description: Unique identifier of the workspace (UUID v4).
        - name: Idempotency-Key
          in: header
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            description: >-
              A key you choose per record to create, such as your system's
              operation id. Send the same key when you retry the request: for 24
              hours it answers with the record the first request created.
            examples:
              - erp-opp-981-create
            title: Idempotency-Key
          description: >-
            A key you choose per record to create, such as your system's
            operation id. Send the same key when you retry the request: for 24
            hours it answers with the record the first request created.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePipelineRecordBody'
              description: Request body to create a pipeline record.
      responses:
        '201':
          description: >-
            The record was created, or a previous request with the same key
            created it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PipelineRecordResponse'
          headers:
            Location:
              description: URL of the record.
              schema:
                type: string
            Idempotent-Replayed:
              description: >-
                `true` when the record comes from a previous request with the
                same key.
              schema:
                type: string
                enum:
                  - 'true'
        '403':
          description: Forbidden
          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: Not Found
          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: Conflict
          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: Unprocessable Content
          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: Too Many Requests
          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: >-
            The contact the record belongs to, given by exactly one of `id`,
            `phone` or `email`.
        pipelineId:
          anyOf:
            - type: string
              maxLength: 255
              minLength: 1
            - type: 'null'
          title: Pipeline Identifier
          description: >-
            Pipeline to create the record in. Defaults to the workspace's
            default pipeline.
          examples:
            - 5d0b8f8e-3c1a-4a4e-9a57-2f6f3e1c9b10
        stageId:
          anyOf:
            - type: string
              maxLength: 255
              minLength: 1
            - type: 'null'
          title: Stage Identifier
          description: >-
            Stage to start the record in. Defaults to the pipeline's initial
            stage; a final stage is refused. The requirements of the stage
            apply, such as a complete contact.
          examples:
            - stage-new
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          description: >-
            Name of the record, up to 200 characters. When missing or blank, the
            contact's full name, then its cellphone, then its email.
          examples:
            - Acme renewal 2027
        externalId:
          anyOf:
            - type: string
              maxLength: 255
              minLength: 1
            - type: 'null'
          title: External Identifier
          description: >-
            Your system's id for the record, unique per pipeline. A second
            record with the same `externalId` in the same pipeline is refused
            with 409 and the id of the existing record.
          examples:
            - ERP-OPP-981
        values:
          additionalProperties: true
          type: object
          title: Values
          description: >-
            Values of the record's attributes, keyed by attribute id. Only
            `RECORD`-scope attributes of the pipeline's current version are
            accepted, each checked against its type (`TEXT` up to 2000
            characters); a `null` value, a blank text and an empty list are left
            out.
          examples:
            - budget: 15000000
              closeDate: '2026-12-15'
              segment: Retail
      additionalProperties: false
      type: object
      required:
        - contact
      title: CreatePipelineRecordBody
      description: Request body to create a pipeline record.
    PipelineRecordResponse:
      properties:
        id:
          type: string
          title: Identifier
          description: Unique identifier of the record.
          examples:
            - 0d3c7f0e-5a43-5c0e-9f53-1f6a4b2e7d11
        pipelineId:
          type: string
          title: Pipeline Identifier
          description: Pipeline the record belongs to.
          examples:
            - 5d0b8f8e-3c1a-4a4e-9a57-2f6f3e1c9b10
        pipelineVersion:
          type: integer
          title: Pipeline Version
          description: Version of the pipeline the record follows.
          examples:
            - 3
        stageId:
          type: string
          title: Stage Identifier
          description: Stage the record is in.
          examples:
            - stage-new
        state:
          $ref: '#/components/schemas/PipelineRecordState'
          title: State
          description: >-
            `OPEN` while the record is in an open stage, `FINAL` once it is in a
            final stage.
          examples:
            - OPEN
        name:
          type: string
          title: Name
          description: Name of the record.
          examples:
            - Acme renewal 2027
        values:
          additionalProperties: true
          type: object
          title: Values
          description: Values of the record's attributes, keyed by attribute id.
          examples:
            - budget: 15000000
              closeDate: '2026-12-15'
        contact:
          $ref: '#/components/schemas/RecordContactResponse'
          title: Contact
          description: The contact the record belongs to.
        ownerId:
          anyOf:
            - type: string
            - type: 'null'
          title: Owner Identifier
          description: >-
            Id of the Bridge User who owns the record. Resolve it with `GET
            /users/{userId}`.
          examples:
            - null
        source:
          $ref: '#/components/schemas/PipelineRecordSource'
          title: Source
          description: >-
            How the record was created: `API`, `ADVISOR`, `INBOUND_SESSION` or
            `FROM_PIPELINE`.
          examples:
            - API
        externalId:
          anyOf:
            - type: string
            - type: 'null'
          title: External Identifier
          description: Your system's id for the record, when it was created with one.
          examples:
            - ERP-OPP-981
        revision:
          type: integer
          title: Revision
          description: Goes up by one every time the record changes.
          examples:
            - 1
        closeReason:
          anyOf:
            - $ref: '#/components/schemas/RecordCloseReasonResponse'
            - type: 'null'
          title: Close Reason
          description: >-
            Reason the record was closed with; null while it is open or when
            closed without one.
        closedAt:
          anyOf:
            - type: string
            - type: 'null'
          title: Closed At
          description: When the record reached a final stage; null while it is open.
          examples:
            - null
        createdAt:
          type: string
          title: Created At
          description: When the record was created.
          examples:
            - '2026-11-11T15:00:00.000Z'
        updatedAt:
          type: string
          title: Updated At
          description: When the record last changed.
          examples:
            - '2026-11-11T15:00:00.000Z'
      type: object
      required:
        - id
        - pipelineId
        - pipelineVersion
        - stageId
        - state
        - name
        - contact
        - source
        - revision
        - createdAt
        - updatedAt
      title: PipelineRecordResponse
      description: A record of a pipeline, such as a sales opportunity of a contact.
    Problem:
      properties:
        title:
          type: string
          title: Title
          description: Short, summary of the problem type.
        status:
          type: integer
          title: Status
          description: >-
            HTTP status code generated by the origin server for this occurrence
            of the problem.
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
          description: Explanation specific to this occurrence of the problem.
        instance:
          anyOf:
            - type: string
            - type: 'null'
          title: Instance
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
        traceId:
          anyOf:
            - type: string
            - type: 'null'
          title: Traceid
          description: Trace ID for debugging purposes.
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: >-
            Error code for identification, view the error codes page for more
            details.
        errors:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          title: Errors
          description: List of error details.
        extra:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Extra
          description: Extra information about the problem.
      type: object
      required:
        - title
        - status
      title: Problem
      description: Object representing a Problem response body.
    RecordContactRequest:
      properties:
        id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Identifier
          description: Contact id, as returned by the Contacts API.
          examples:
            - 4e362e2b-67b2-4a7e-a9df-e9ecf9141be8
        phone:
          anyOf:
            - type: string
              maxLength: 320
              minLength: 1
            - type: 'null'
          title: Phone
          description: >-
            Contact cellphone, read like `GET /contacts/lookup` reads it: a
            number without a country code is read in the workspace's default
            country.
          examples:
            - '+573001234567'
        email:
          anyOf:
            - type: string
              maxLength: 320
              minLength: 1
            - type: 'null'
          title: Email
          description: Contact email, read like `GET /contacts/lookup` reads it.
          examples:
            - john.doe@example.com
      additionalProperties: false
      type: object
      title: RecordContactRequest
      description: >-
        The contact the record belongs to, given by exactly one of its
        identifiers. The contact is never created.
    PipelineRecordState:
      type: string
      enum:
        - OPEN
        - FINAL
      title: PipelineRecordState
    RecordContactResponse:
      properties:
        id:
          type: string
          title: Identifier
          description: Contact id. Resolve it with `GET /contacts/{contactId}`.
          examples:
            - 4e362e2b-67b2-4a7e-a9df-e9ecf9141be8
      type: object
      required:
        - id
      title: RecordContactResponse
      description: The contact a record belongs to.
    PipelineRecordSource:
      type: string
      enum:
        - ADVISOR
        - API
        - INBOUND_SESSION
        - FROM_PIPELINE
      title: PipelineRecordSource
    RecordCloseReasonResponse:
      properties:
        id:
          type: string
          title: Identifier
          description: Close reason id, as listed by `GET /pipelines/{pipelineId}`.
          examples:
            - reason-price
        label:
          type: string
          title: Label
          description: Name of the close reason when the record was closed.
          examples:
            - Price too high
        note:
          anyOf:
            - type: string
            - type: 'null'
          title: Note
          description: Free text written when the record was closed.
          examples:
            - null
      type: object
      required:
        - id
        - label
      title: RecordCloseReasonResponse
      description: The reason a closed record was closed with.
  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.