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

# Request a manual handoff of a LeadScout conversation to internal users

> Request a manual handoff of a LeadScout-controlled conversation to one or more internal users.

The request is acknowledged with `202 Accepted`; assignment is processed asynchronously.
The response echoes the requested assignees and a tracking id for correlation. Internal-user
resolution (by ID or EMAIL) happens downstream and is not reflected in this response.



## OpenAPI

````yaml /api-reference/openapi.yaml post /bridge/api/v1/workspaces/{workspaceId}/leadscout/conversations/{conversationId}/handoff
openapi: 3.1.0
info:
  title: Bridge API
  summary: Bridge API specification for chat system management.
  description: >-
    Bridge API specification including webhook receiver endpoints, Contact CRUD
    operations, and comprehensive chat system.

                        This API includes:
                        1. Webhook Receiver API - for CRM clients to receive event notifications from Bridge
                        2. Contact CRUD API - for clients to manage contacts in Bridge
                        3. Conversations API - for managing conversations with flexible user identification and participant management
                        4. Messages API - for sending messages and files to a conversation
                        5. Files API - for managing files in a message
                        6. Custom attributes API - for consult custom attributes of an specific workspace
                    
                        **Multi-Tenant Architecture**: All operations are scoped to a specific workspace using workspaceId.
  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}/leadscout/conversations/{conversationId}/handoff:
    post:
      tags:
        - LeadScout API
      summary: Request a manual handoff of a LeadScout conversation to internal users
      description: >-
        Request a manual handoff of a LeadScout-controlled conversation to one
        or more internal users.


        The request is acknowledged with `202 Accepted`; assignment is processed
        asynchronously.

        The response echoes the requested assignees and a tracking id for
        correlation. Internal-user

        resolution (by ID or EMAIL) happens downstream and is not reflected in
        this response.
      operationId: >-
        request_leadscout_handoff_bridge_api_v1_workspaces__workspaceId__leadscout_conversations__conversationId__handoff_post
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            format: uuid
            description: Unique identifier of the workspace (UUID v4).
            title: Workspaceid
          description: Unique identifier of the workspace (UUID v4).
        - name: conversationId
          in: path
          required: true
          schema:
            type: string
            description: Identifier of the conversation to hand off.
            title: Conversationid
          description: Identifier of the conversation to hand off.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HandoffRequest'
              description: Request body for a LeadScout manual handoff.
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HandoffResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - x-api-key: []
components:
  schemas:
    HandoffRequest:
      properties:
        assignees:
          items:
            $ref: '#/components/schemas/HandoffAssignee'
          type: array
          minItems: 1
          title: Assignees
          description: >-
            Internal users to hand the conversation off to. At least one is
            required.
        handoffMessages:
          items:
            type: string
          type: array
          title: Handoff Messages
          description: Optional message bodies posted as part of the handoff.
        includeAiLeadSummary:
          type: boolean
          title: Include AI Lead Summary
          description: >-
            When true, the handoff message should include an AI-generated
            summary of the lead.
          default: false
      additionalProperties: false
      type: object
      required:
        - assignees
      title: HandoffRequest
      description: Request body for a LeadScout manual handoff.
    HandoffResponse:
      properties:
        trackingId:
          type: string
          title: Tracking Identifier
          description: Correlation id generated for this handoff request.
        conversationId:
          type: string
          title: Conversation Identifier
          description: The conversation the handoff targets.
        status:
          type: string
          title: Status
          description: Acceptance status of the handoff request.
          examples:
            - ACCEPTED
        assignees:
          items:
            $ref: '#/components/schemas/HandoffAssignee'
          type: array
          title: Assignees
          description: Echo of the assignees received in the request.
      type: object
      required:
        - trackingId
        - conversationId
        - status
        - assignees
      title: HandoffResponse
      description: Response body acknowledging an accepted handoff request.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    HandoffAssignee:
      properties:
        identifier:
          type: string
          title: Identifier
          description: ID value or email of the internal user, depending on identifierType.
          examples:
            - u-123
            - ana@acme.com
        identifierType:
          $ref: '#/components/schemas/InternalParticipantIdentifierType'
          title: Identifier Type
          description: >-
            Lookup strategy for the internal user. Only ID and EMAIL are
            supported.
          examples:
            - ID
            - EMAIL
      additionalProperties: false
      type: object
      required:
        - identifier
        - identifierType
      title: HandoffAssignee
      description: An internal user to assign the conversation to during a handoff.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    InternalParticipantIdentifierType:
      type: string
      enum:
        - ID
        - EMAIL
      title: InternalParticipantIdentifierType
  securitySchemes:
    x-api-key:
      type: apiKey
      description: Copy the API key as provided by the Bridge Console.
      in: header
      name: x-api-key

````