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

# Update an agent

> Partial update: only the fields sent change (PUT is accepted too).



## OpenAPI

````yaml /api-reference/v2.0/openapi.json patch /agents/{id}
openapi: 3.1.0
info:
  title: Shortext API
  description: >-
    **Versioning**: every version is a frozen contract. A released version only
    receives additive changes

    (new endpoints, new optional fields, new response fields); anything breaking
    ships in a new version.

    Responses carry `X-Shortext-Api-Version`. When a version is scheduled for
    removal, responses also carry

    `Deprecation` and `Sunset` headers; after the sunset date the version
    answers HTTP 410.

    The list of versions and their status is available at `GET /api/versions`.


    **Responses**: always HTTP 200. Check `success` and `code` (`1000` =
    success), see `ApiEnvelope`.

    On failure, `trace_id` identifies the request for support.
  version: '2.0'
servers:
  - url: https://shortext.ny-corp.io/api/v2.0
security: []
tags:
  - name: Agents
    description: Agents
  - name: Channels
    description: Channels
  - name: Conversations
    description: Conversations
  - name: Account
    description: Account
  - name: Templates
    description: Templates
  - name: Hosted sessions
    description: Hosted sessions
  - name: Webhooks
    description: Webhooks
paths:
  /agents/{id}:
    patch:
      tags:
        - Agents
      summary: Update an agent
      description: 'Partial update: only the fields sent change (PUT is accepted too).'
      operationId: updateAgent
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgentInput'
      responses:
        '200':
          description: >-
            Always HTTP 200: the outcome is in `success` and `code` (absolute
            value of the response code).
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ApiEnvelope'
                  - properties:
                      body:
                        $ref: '#/components/schemas/Agent'
                    type: object
      security:
        - bearerAuth: []
components:
  schemas:
    AgentInput:
      properties:
        name:
          description: Required on creation
          type: string
          maxLength: 255
        active:
          type: boolean
          default: true
        use_ai:
          type: boolean
          default: true
        inactive_message:
          type:
            - string
            - 'null'
          maxLength: 1000
        instructions:
          description: System prompt; empty or null removes it
          type:
            - string
            - 'null'
          maxLength: 15000
      type: object
    ApiEnvelope:
      properties:
        success:
          type: boolean
          example: true
        code:
          type: integer
          example: 1000
        message:
          type: string
          example: Request success.
        body:
          description: Endpoint payload, null when there is none
        token:
          description: Present only on authentication routes
          type:
            - string
            - 'null'
        trace_id:
          description: Present only when success is false
          type:
            - string
            - 'null'
      type: object
    Agent:
      properties:
        id:
          description: Public representation of an agent (API v2.0 and webhooks)
          type: string
          example: AGI-XXXXX
        name:
          type: string
          example: Support
        active:
          description: An inactive agent stores messages without answering
          type: boolean
        use_ai:
          description: The AI answers, following the instructions
          type: boolean
        inactive_message:
          description: Fixed answer when the AI is off
          type:
            - string
            - 'null'
        instructions:
          description: System prompt of the AI
          type:
            - string
            - 'null'
        channels:
          description: Not in webhook payloads
          type: array
          items:
            $ref: '#/components/schemas/Channel'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      type: object
    Channel:
      properties:
        type:
          description: >-
            Public representation of a channel (API v2.0 and webhooks). The id
            is the one webhooks use as channel_id.
          type: string
          enum:
            - whatsapp
            - mail
            - shortext
          example: whatsapp
        id:
          description: >-
            Channel id (the channel_id of the webhooks): WhatsApp phone number
            id, mailbox id (mbx_...) or Shortext endpoint id (ste_...)
          type: string
          example: '532867649916076'
        name:
          type: string
          example: +237 6 99 99 99 99 (Acme)
        enabled:
          type: boolean
        agent:
          description: >-
            null when the channel is detached: messages are stored, nobody
            answers automatically
          properties:
            id:
              type: string
              example: AGI-XXXXX
            name:
              type: string
          type:
            - object
            - 'null'
        settings:
          description: 'Shortext only: endpoint settings (null for the other channels)'
          properties:
            client_type:
              type: string
              example: server
            inbound_url:
              description: Where your server posts the messages of your users
              type: string
            reply_mode:
              description: >-
                `async`: replies pushed to webhook_url; `sync`: replies in the
                inbound response
              type: string
              enum:
                - async
                - sync
            sync_timeout:
              description: Seconds the sync mode waits for the replies
              type: integer
            webhook_url:
              type:
                - string
                - 'null'
          type:
            - object
            - 'null'
        created_at:
          type: string
          format: date-time
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      description: >-
        Company API key, sent as `Authorization: Bearer <key>`. Create it in the
        dashboard (Developer > API Keys) with the permissions the integration
        needs.
      scheme: bearer

````

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