---
title: "Update an agent"
method: PUT
path: "/public/v1/agents/{agentId}"
tags: ["Agent Builder"]
---

# Update an agent

`PUT /public/v1/agents/{agentId}`

Updates basic agent metadata. Requires a USER API key.

## Path parameters

- `agentId` string, required

## Request body

- PublicAgentUpdateInput
  - `name` string, required

## Response `200`

Updated agent

- AgentDetail
  - `id` string, required
  - `name` string, required
  - `description` string, nullable, required
  - `status` 'NONE' | 'ACTIVE' | 'INACTIVE' | 'TRAINING' | 'TRAIN_ERROR', required
  - `createdAt` string, required
  - `updatedAt` string, required
  - `isOffline` boolean, required
  - `ownerId` number
  - `accountId` number, required
  - `theme` AgentTheme, nullable
    - `id` number, required
    - `assistantId` string
    - `avatar` string, nullable, required
    - `bubbleImage` string, nullable, required
    - `title` string, required
    - `initialMessage` string, required
    - `placeholder` string, required
    - `bubbleColor` string, required
    - `userMessageColor` string, required
    - `agentMessageColor` string, nullable, required
    - `bubbleAlignment` 'RIGHT' | 'LEFT', required
    - `progressIndicator` 'STATIC' | 'DYNAMIC', required
    - `verticalPositionInPixels` number, required
    - `removePowerBy` boolean
    - `updatedAt` string
  - `agentSetting` AgentSetting, nullable
    - `id` number, required
    - `aiModelId` number, nullable
    - `aiModel` AiModel
      - `id` number, required
      - `name` string, required
      - `description` string, nullable
      - `creditsPerMessage` number
      - `isDefault` boolean
      - `order` number
      - `analyticsColor` string, nullable
      - `externalId` string, nullable
      - `aiVendor` string
      - `reasoningModel` boolean
      - `type` 'TEXT' | 'TRANSCRIPTION' | 'FILE_ANALYSIS'
    - `model` string, nullable
    - `aiType` 'ASSISTANT' | 'AGENT'
    - `temperature` number
    - `instructions` string, nullable
    - `agentRole` 'NONE' | 'CUSTOM' | 'CUSTOMER_SUPPORT' | 'SALES_REPRESENTATIVE' | 'COLLECTIONS' | 'RECRUITING_AGENT' | 'HR_MANAGER' | 'PRODUCT_COPILOT' | 'AI_ASSISTANT' | 'ANALYST' | 'POST_SALES'
    - `toneOfVoice` 'NONE' | 'CUSTOM' | 'FRIENDLY' | 'NEUTRAL' | 'MATTER_OF_FACT' | 'PROFESSIONAL' | 'HUMOROUS' | 'WITTY' | 'GEN_Z'
    - `answerLength` 'NONE' | 'CUSTOM' | 'DYNAMIC' | 'CONCISE' | 'STANDARD' | 'THOROUGH'
    - `maxIterations` number
    - `agentType` 'BASIC' | 'ADVANCED'
    - `customTools` object[], nullable
      - `id` number, required
      - `name` string, required
      - `description` string, nullable
      - `status` string, nullable
      - `type` string, nullable
    - `systemToolsConfig` object, nullable
    - `selectedRecordTypes` object[], nullable
      - `recordTypeId` number, required
      - `read` boolean
      - `create` boolean
      - `update` boolean
      - `delete` boolean
      - `createActivity` boolean
    - `agentConnectedAccounts` object[], nullable
      - `connectedAccountId` number, required
      - `useAllTools` boolean, required
      - `selectedToolSlugs` string[], nullable
      - `connectedAccount` object
        - `id` number, required
        - `toolkit` string, required
        - `alias` string, nullable, required
        - `connectedEmail` string, nullable, required
        - `isConnected` boolean, required
    - `agentPlaybooks` object[], nullable
      - `playbookId` number, required
      - `assignedAt` string
      - `playbook` object
        - `id` number, required
        - `name` string, required
        - `description` string, nullable
  - `channel` object, nullable
    - `id` number, required
    - `channelLiveChat` object, nullable
      - `splitMessages` boolean, required
      - `splitCharacterLimit` integer, required
      - `closeAfter` number, nullable, required
      - `timeUnit` 'MINUTES' | 'HOURS', nullable, required
      - `conversationClose` 'NEVER' | 'AUTOMATICALLY' | 'DYNAMICALLY', required
      - `collectFeedback` boolean, required
      - `feedbackVisibility` 'ON_HOVER' | 'ALWAYS_VISIBLE', required
      - `feedbackText` string, nullable, required
      - `collectFeedbackReason` boolean, required
      - `includeOtherReason` boolean, required
      - `openFeedbackText` string, nullable, required
      - `feedbackReasons` object[], nullable
        - `id` number, required
        - `reason` string, required
        - `order` number, required
      - `enableDocumentProcessing` boolean
      - `enableImageProcessing` boolean
      - `enableIdle` boolean, required
      - `idleSettings` object, nullable
        - `id` number, nullable
        - `after` number, nullable, required
        - `timeUnit` 'MINUTES' | 'HOURS', nullable, required
        - `resetsLimit` number, nullable, required
      - `id` number, required
    - `channelWhatsapp` object, nullable
      - `splitMessages` boolean, required
      - `splitCharacterLimit` integer, required
      - `closeAfter` number, nullable
      - `timeUnit` 'MINUTES' | 'HOURS', nullable
      - `conversationClose` 'NEVER' | 'AUTOMATICALLY' | 'DYNAMICALLY', nullable
      - `enableDocumentProcessing` boolean
      - `enableImageProcessing` boolean
      - `debounce` boolean
      - `debounceTime` integer
      - `enableIdle` boolean, required
      - `idleSettings` object, nullable
        - `id` number, nullable
        - `after` number, nullable, required
        - `timeUnit` 'MINUTES' | 'HOURS', nullable, required
        - `resetsLimit` number, nullable, required
      - `conversationInterruptTimeout` integer
      - `conversationInterruptTimeUnit` 'MINUTES' | 'HOURS', nullable
      - `sendCloseMessage` boolean, required
      - `closeMessageType` 'STATIC' | 'DYNAMIC', required
      - `closeMessage` string, nullable
      - `closeInstruction` string, nullable
      - `autoReplyOnUninterrupt` boolean
      - `id` number, required
    - `channelInstagram` object, nullable
      - `splitMessages` boolean, required
      - `splitCharacterLimit` integer, required
      - `closeAfter` number, nullable
      - `timeUnit` 'MINUTES' | 'HOURS', nullable
      - `conversationClose` 'NEVER' | 'AUTOMATICALLY' | 'DYNAMICALLY', nullable
      - `enableImageProcessing` boolean
      - `enableIdle` boolean, required
      - `idleSettings` object, nullable
        - `id` number, nullable
        - `after` number, nullable, required
        - `timeUnit` 'MINUTES' | 'HOURS', nullable, required
        - `resetsLimit` number, nullable, required
      - `conversationInterruptTimeout` integer
      - `conversationInterruptTimeUnit` 'MINUTES' | 'HOURS', nullable
      - `sendCloseMessage` boolean, required
      - `closeMessageType` 'STATIC' | 'DYNAMIC', required
      - `closeMessage` string, nullable
      - `closeInstruction` string, nullable
      - `autoReplyOnUninterrupt` boolean
      - `id` number, required
    - `channelMessenger` object, nullable
      - `splitMessages` boolean, required
      - `splitCharacterLimit` integer, required
      - `closeAfter` number, nullable
      - `timeUnit` 'MINUTES' | 'HOURS', nullable
      - `conversationClose` 'NEVER' | 'AUTOMATICALLY' | 'DYNAMICALLY', nullable
      - `enableImageProcessing` boolean
      - `enableIdle` boolean, required
      - `idleSettings` object, nullable
        - `id` number, nullable
        - `after` number, nullable, required
        - `timeUnit` 'MINUTES' | 'HOURS', nullable, required
        - `resetsLimit` number, nullable, required
      - `conversationInterruptTimeout` integer
      - `conversationInterruptTimeUnit` 'MINUTES' | 'HOURS', nullable
      - `autoReplyOnUninterrupt` boolean
      - `sendCloseMessage` boolean, required
      - `closeMessageType` 'STATIC' | 'DYNAMIC', required
      - `closeMessage` string, nullable
      - `closeInstruction` string, nullable
      - `id` number, required

## Other responses

- `404` — Not Found

---

[API](https://skmtc.net/getfrontline/apis/public-api.md) · [All operations](https://skmtc.net/getfrontline/apis/public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/getfrontline/public-api/versions/9d33b6aad674/schema)