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

# Update an agent connection



## OpenAPI

````yaml openapi.json PATCH /v1/agents/{agentId}/connections/{connectionId}
openapi: 3.1.0
info:
  title: Egma Platform API
  version: 1.0.0
  description: >-
    The customer-facing HTTP interface used by Egma's web app, CLI, and outside
    clients.
servers:
  - url: https://app.egma.ai
security: []
paths:
  /v1/agents/{agentId}/connections/{connectionId}:
    patch:
      tags:
        - Connections
      summary: Update an agent connection
      operationId: updateConnection
      parameters:
        - name: agentId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
        - name: connectionId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
        - name: projectId
          in: query
          required: false
          schema:
            type: string
            minLength: 1
            description: >-
              Project to act in. A project-scoped API key already identifies its
              project.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                environment:
                  anyOf:
                    - type: string
                    - type: 'null'
                config:
                  type: object
                  additionalProperties: true
                credentials:
                  type: object
                  additionalProperties: true
              additionalProperties: false
      responses:
        '200':
          description: The updated connection.
          content:
            application/json:
              schema:
                type: object
                properties:
                  connection:
                    type: object
                    properties:
                      id:
                        type: string
                        minLength: 1
                      agentId:
                        type: string
                        minLength: 1
                      projectId:
                        type: string
                        minLength: 1
                      name:
                        type: string
                      agentPlatform:
                        type: string
                        enum:
                          - retell
                          - livekit
                      connectionType:
                        type: string
                        enum:
                          - retell_chat_api
                          - retell_text_mode
                          - retell_web_call
                          - phone_number
                          - livekit_room
                      accessVariant:
                        type: string
                        enum:
                          - retell_chat_api.api_key
                          - retell_text_mode.api_key
                          - retell_web_call.api_key
                          - phone_number.public_e164
                          - livekit_room.project_credentials
                          - livekit_room.customer_token_endpoint
                      modality:
                        type: string
                        enum:
                          - voice
                          - chat
                      productLabel:
                        type: string
                      topology:
                        type: string
                        enum:
                          - agent-dials-out
                          - hosted-broker
                          - egma-dials-in
                      environment:
                        anyOf:
                          - type: string
                          - type: 'null'
                      config:
                        type: object
                        additionalProperties:
                          type: string
                      credentialPresent:
                        type: boolean
                      credentialsHint:
                        anyOf:
                          - type: string
                          - type: 'null'
                      archived:
                        type: boolean
                      archivedAt:
                        anyOf:
                          - type: string
                            format: date-time
                          - type: 'null'
                      createdAt:
                        type: string
                        format: date-time
                      updatedAt:
                        type: string
                        format: date-time
                    required:
                      - id
                      - agentId
                      - projectId
                      - name
                      - agentPlatform
                      - connectionType
                      - accessVariant
                      - modality
                      - productLabel
                      - topology
                      - environment
                      - config
                      - credentialPresent
                      - credentialsHint
                      - archived
                      - archivedAt
                      - createdAt
                      - updatedAt
                    additionalProperties: false
                required:
                  - connection
                additionalProperties: false
        '400':
          description: The request was refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
        '401':
          description: The request was refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
        '403':
          description: The request was refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
        '404':
          description: The request was refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
        '409':
          description: The request was refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
        '422':
          description: The request was refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
        '429':
          description: The request rate limit was reached.
          headers:
            Retry-After:
              description: Seconds to wait before trying again.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
        '503':
          description: The request was refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
      security:
        - bearerAuth: []
        - sessionCookie: []
components:
  schemas:
    Refusal:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
        details:
          type: object
          additionalProperties: true
      required:
        - error
        - message
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An Egma API key.
    sessionCookie:
      type: apiKey
      in: cookie
      name: egma.session_token
      description: >-
        The browser session cookie issued by Egma. HTTPS deployments add the
        standard __Secure- prefix.

````