# Archive an agent

Archive a specific agent

Endpoint: POST /agents/{agentId}/archive
Version: 1.0.0
Security: BearerAuth

## Path parameters:

  - `agentId` (string, required)

## Response 200 fields (application/json):

  - `success` (boolean, required)
    Enum: true

  - `data` (object, required)

  - `data.id` (number, required)

  - `data.organizationId` (string, required)

  - `data.name` (string, required)

  - `data.voiceId` (string, required)

  - `data.language` (string, required)
    Enum: "en", "es"

  - `data.metadata` (object)

  - `data.metadata.firstMessage` (string)

  - `data.metadata.llmModel` (string)
    Enum: "gpt-4o-mini", "gpt-4o", "claude-3.7-sonnet", "claude-3.5-haiku"

  - `data.metadata.modelTemperature` (number)

  - `data.metadata.voiceSpeed` (number)

  - `data.metadata.voiceTemperature` (number)

  - `data.metadata.interruptionSensitivity` (number)

  - `data.metadata.maxCallDurationMs` (number)

  - `data.metadata.endCallAfterSilenceMs` (number)

  - `data.metadata.enableTranscriptionFormatting` (boolean)

  - `data.metadata.enableVoicemailDetection` (boolean)

  - `data.metadata.voicemailMessage` (string)

  - `data.metadata.ambientSound` (string)
    Enum: "none", "coffee-shop", "convention-hall", "summer-outdoor", "mountain-outdoor", "static-noise", "call-center"

  - `data.metadata.pronunciationDictionary` (array)

  - `data.metadata.pronunciationDictionary.word` (string, required)

  - `data.metadata.pronunciationDictionary.pronunciation` (string, required)

  - `data.metadata.pronunciationDictionary.alphabet` (string, required)
    Enum: "ipa", "cmu"

  - `data.metadata.pronunciationDictionary.phoneme` (string, required)

  - `data.metadata.calendarConfig` (object,null)

  - `data.metadata.calendarConfig.apiKey` (string, required)

  - `data.metadata.calendarConfig.eventTypeId` (number, required)

  - `data.metadata.transferNumber` (string,null)

  - `data.metadata.enableIvr` (boolean)

  - `data.metadata.enableEndCall` (boolean)

  - `data.metadata.postCallAnalysisData` (array)

  - `data.metadata.postCallAnalysisData.type` (string, required)
    Enum: "boolean", "string", "number"

  - `data.metadata.postCallAnalysisData.description` (string, required)

  - `data.metadata.enableBackchanneling` (boolean)

  - `data.metadata.backchannelMessages` (array)

  - `data.metadata.backchannelMessages.message` (string, required)

  - `data.metadata.backchannelMessages.minSilenceMs` (number, required)

  - `data.context` (string)

  - `data.templateType` (string, required)
    Enum: "book_meeting", "warm_up", "qualify", "blank"

  - `data.status` (string, required)
    Enum: "draft", "active", "inactive", "archived"

  - `data.createdAt` (string, required)

  - `data.updatedAt` (string, required)

## Response 401 fields (application/json):

  - `success` (boolean, required)
    Enum: false

  - `error` (string, required)

  - `details` (string)

## Response 403 fields (application/json):

  - `success` (boolean, required)
    Enum: false

  - `error` (string, required)

  - `details` (string)

## Response 404 fields (application/json):

  - `success` (boolean, required)
    Enum: false

  - `error` (string, required)

  - `details` (string)

## Response 500 fields (application/json):

  - `success` (boolean, required)
    Enum: false

  - `error` (string, required)

  - `details` (string)