> ## Documentation Index
> Fetch the complete documentation index at: https://docs.impellabs.tech/llms.txt
> Use this file to discover all available pages before exploring further.

# Take over or give back

> Sets who answers. `on` true (default) means a person has the conversation and the agent is silent. `on` false gives it back to the agent. Needs the `messages:write` scope.



## OpenAPI

````yaml /openapi/partner.yaml post /api/v1/partner/tenants/{external_ref}/conversations/{session_id}/handoff/
openapi: 3.1.0
info:
  title: ImpelLabs Partner API
  version: '1'
  description: >-
    The Partner API provisions customer businesses (tenants) and runs their
    channels, conversations and templates from your own product. Call it from
    your server with a partner key. Every path ends with a slash.
servers:
  - url: https://api.impellabs.tech
security:
  - bearer: []
tags:
  - name: Keys
    description: Your partner API keys.
  - name: Tenants
    description: Customer businesses, their channels, conversations and templates.
  - name: Webhooks
    description: Where your tenants' events go.
  - name: WhatsApp sign-up
    description: The settings of the hosted WhatsApp sign-up.
paths:
  /api/v1/partner/tenants/{external_ref}/conversations/{session_id}/handoff/:
    post:
      tags:
        - Tenants
      summary: Take over or give back
      description: >-
        Sets who answers. `on` true (default) means a person has the
        conversation and the agent is silent. `on` false gives it back to the
        agent. Needs the `messages:write` scope.
      operationId: >-
        post_api_v1_partner_tenants_external_ref_conversations_session_id_handoff
      parameters:
        - name: external_ref
          in: path
          required: true
          schema:
            type: string
          description: Your own id for the customer business, set when you created it.
        - name: session_id
          in: path
          required: true
          schema:
            type: string
          description: The conversation id (UUID).
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                'on':
                  type: boolean
                  description: Default true.
                reason:
                  type: string
                  description: A short reason. 32 characters at most.
            example:
              'on': true
              reason: billing question
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                id: 5d2f7a3e-0000-4000-8000-000000000000
                object: conversation
                status: active
                agent: null
                agent_version: null
                channel: whatsapp
                external_ref: null
                turns: 3
                metadata: {}
                created_at: '2026-01-15T10:00:00+00:00'
                updated_at: '2026-01-15T10:05:00+00:00'
                contact:
                  name: Sam
                  phone: '+15550100101'
                  lead_id: 8a1e0c7b-0000-4000-8000-000000000000
                human_control:
                  'on': false
                  reason: ''
                  since: ''
                  state: ai
                  pending_since: ''
                window:
                  open: true
                  last_inbound_at: '2026-01-15T10:04:00+00:00'
                  closes_at: '2026-01-16T10:04:00+00:00'
                capabilities:
                  can_text: true
                  can_template: true
                  can_media: true
                  window_open: true
                  window:
                    open: true
                  tags: []
                whatsapp_number: '100000000000001'
        '400':
          $ref: '#/components/responses/Invalid'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        4XX:
          description: The request is not valid or not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  responses:
    Invalid:
      description: >-
        A field is missing or wrong. The body names each field: {"field": "what
        to fix"}.
    Unauthorized:
      description: The credentials are missing, wrong, expired or revoked.
    Forbidden:
      description: These credentials may not do this.
    NotFound:
      description: There is no such row, or these credentials cannot see it.
  schemas:
    Error:
      type: object
      description: >-
        An error. Most errors carry `detail`. Some carry `error` with `code` and
        `message`.
      properties:
        detail:
          type: string
        code:
          type: string
        field:
          type: string
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````

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