AI Agent

Turn an agent on or off

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.

patch/companies/{company}/agents/{agent}/enabled

Path parameters

companyinteger required

agentinteger required

Agent ID

Request body

enabledboolean required

Response

Updated agent

idinteger

externalIdstring

providerstring

namestring nullable

descriptionstring nullable

industrystring nullable

googlePlaceIdstring nullable

voiceIdstring nullable

voiceLanguagestring

additionalLanguagesstring[]

Extra language codes the agent supports beyond its primary voiceLanguage.

languagePresetsobject

Per-language greeting/prompt overrides, keyed by language code.

scheduleIdinteger nullable

callTrainingAnalysisIdinteger nullable

websiteAnalysisIdinteger nullable

enabledboolean

While false the agent answers nothing: numbers and call flows assigned to it fall through to their regular routing.

voicemailFallbackEnabledboolean

transferSummaryEnabledboolean

escalationPolicystring nullable

callerIdentityEnabledboolean

messageCaptureEnabledboolean

callbackCaptureEnabledboolean

callerIdentityFirstMessagestring nullable

voiceSpeednumber float nullable

backgroundMusicSourceId'office1' | 'office2' | 'restaurant' | 'city' | 'typing' nullable

backgroundMusicVolumenumber float nullable

promptstring nullable

firstMessagestring nullable

dynamicVariablesobject nullable

toolIdsstring[] nullable

deployedAtstring date-time nullable

companyIdinteger nullable

businessUnitIdinteger nullable

knowledgeBaseIdsinteger[]

assignmentsCountinteger nullable

answeringCountinteger nullable

Assignments where the agent currently answers; null unless the endpoint computed it.

createdAtstring date-time

updatedAtstring date-time

Example response

{
  "fallbacks": [
    {
      "destination": {
        "value": "nt:12"
      }
    }
  ],
  "schedule": {
    "preset": "custom",
    "timezone": "America/Chicago",
    "timezone_source": "explicit"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.