---
title: "Turn an agent on or off"
method: PATCH
path: "/companies/{company}/agents/{agent}/enabled"
tags: ["AI Agent"]
---

# Turn an agent on or off

`PATCH /companies/{company}/agents/{agent}/enabled`

Controls whether the agent answers calls. While off, the numbers and call flows assigned to it fall
through to their regular routing; the per-number settings are kept, so turning it back on restores them.

The flag is routing-only, so this endpoint does not redeploy the agent.

## Path parameters

- `company` integer, required
- `agent` integer, required

## Request body

- object
  - `enabled` boolean, required

## Response `200`

Updated agent

- AgentResource
  - `id` integer
  - `externalId` string
  - `provider` string
  - `name` string, nullable
  - `description` string, nullable
  - `industry` string, nullable
  - `googlePlaceId` string, nullable
  - `voiceId` string, nullable
  - `voiceLanguage` string
  - `additionalLanguages` string[] — Extra language codes the agent supports beyond its primary voiceLanguage.
  - `languagePresets` object — Per-language greeting/prompt overrides, keyed by language code.
  - `scheduleId` integer, nullable
  - `callTrainingAnalysisId` integer, nullable
  - `websiteAnalysisId` integer, nullable
  - `enabled` boolean — While false the agent answers nothing: numbers and call flows assigned to it fall through to their regular routing.
  - `voicemailFallbackEnabled` boolean
  - `transferSummaryEnabled` boolean
  - `escalationPolicy` string, nullable
  - `callerIdentityEnabled` boolean
  - `messageCaptureEnabled` boolean
  - `callbackCaptureEnabled` boolean
  - `callerIdentityFirstMessage` string, nullable
  - `voiceSpeed` number, float, nullable
  - `backgroundMusicSourceId` 'office1' | 'office2' | 'restaurant' | 'city' | 'typing', nullable
  - `backgroundMusicVolume` number, float, nullable
  - `prompt` string, nullable
  - `firstMessage` string, nullable
  - `dynamicVariables` object, nullable
  - `toolIds` string[], nullable
  - `deployedAt` string, date-time, nullable
  - `companyId` integer, nullable
  - `businessUnitId` integer, nullable
  - `createdBy` object, nullable
    - `id` integer
    - `name` string
  - `template` object, nullable
    - `key` string
    - `name` string
  - `skills` AgentSkillResource[]
    - `id` integer
    - `name` string, nullable
    - `description` string, nullable
    - `prompt` string
    - `enabled` boolean
    - `knowledgeBaseIds` integer[], nullable
    - `dataGroupId` integer, nullable
    - `toolIds` string[], nullable
    - `template` object
      - `key` string
      - `name` string
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
  - `fallbacks` AgentFallbackResource[]
    - `id` integer
    - `reasons` string[]
    - `customReason` string, nullable
    - `destination` object — Where the agent escalates to. `value` is the round-trippable string to send back on update; `type` is derived from it, never stored, and is null when the stored value carries a prefix the platform does not recognise. `targetId` is set for the types that have one, and `label` is the resolved human name (null when the target no longer exists).
      - `type` 'NUMBER' | 'SIP' | 'WEBSOCKET' | 'DESTINATION' | 'USER' | 'AGENT' | 'NUMBER_TEMPLATE', nullable
      - `value` string
      - `targetId` integer, nullable
      - `label` string, nullable
    - `phoneNumber` string — Deprecated: the raw stored destination. Retained so existing clients keep round-tripping; read `destination` instead.
    - `createdAt` string, date-time
  - `pronunciationAliases` AgentPronunciationAliasResource[]
    - `id` integer
    - `type` 'text' | 'dynamicVariable'
    - `stringToReplace` string, nullable
    - `dynamicVariableKey` string, nullable
    - `alias` string
    - `caseSensitive` boolean
    - `wordBoundaries` boolean
    - `position` integer
    - `dictionaryExternalId` string, nullable
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
  - `calendarSource` object, nullable
    - `type` 'calendar' | 'googlecalendar' | 'calendly' | 'outlook' | 'outlookbookings' | 'hubspot'
    - `id` integer
    - `name` string, nullable
    - `provider` string, nullable
    - `providerUserId` string, nullable
    - `isEnabled` boolean, nullable
    - `userInfo` object, nullable
  - `knowledgeBaseIds` integer[]
  - `schedule` ScheduleResource
    - `id` integer
    - `preset` 'always' | 'weekdays' | 'weekends' | 'custom' | 'direct_vm' | 'inherit' | 'outside_business_hours'
    - `timezone` string — Resolved IANA timezone (never the "account" sentinel).
    - `timezone_source` 'account' | 'explicit'
    - `blocks` unknown[]
      - unknown
    - `context` object
      - `id` integer
      - `type` unknown
  - `notificationRules` AgentNotificationRuleResource[]
    - `id` integer — One notification rule on an AI Agent (DEV-2656).
    - `name` string, nullable
    - `enabled` boolean
    - `frequency` 'every_call' | 'important_only' | 'daily_digest'
    - `importantCallTriggers` string[]
    - `importantCallDurationThresholdSecs` integer
    - `digestTime` string, nullable — Daily digest send time as HH:MM. Accepted as HH:MM or HH:MM:SS on write.
    - `emailEnabled` boolean
    - `recipients` string[]
    - `pushEnabled` boolean
    - `pushUserIds` integer[]
    - `createdAt` string, date-time, nullable
    - `updatedAt` string, date-time, nullable
  - `postCallEmail` object
    - `enabled` boolean
    - `frequency` 'every_call' | 'important_only' | 'daily_digest'
    - `recipients` string[]
    - `importantCallTriggers` string[]
    - `importantCallDurationThresholdSecs` integer
    - `digestTime` string, nullable
  - `assignmentsCount` integer, nullable
  - `answeringCount` integer, nullable — Assignments where the agent currently answers; null unless the endpoint computed it.
  - `createdAt` string, date-time
  - `updatedAt` string, date-time

## Other responses

- `404` — Agent not found

---

[API](https://skmtc.dev/800/apis/public-api.md) · [All operations](https://skmtc.dev/800/apis/public-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/800/public-api/revisions/aab9efc97342/schema)