Toggle an agent active status

PATCH

/agents/{id}/toggle

Flips the agent's isActive flag to quickly pause or resume it without losing configuration. Inactive agents don't receive calls. Use for off-hours pause, maintenance windows, or a single-click enable/disable control in the UI.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Responses

🟢200

application/json

The agent has been successfully toggled.

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/agents//toggle' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "id": "string",
    "name": "string",
    "description": "string",
    "avatar": "string",
    "isPublic": true,
    "isActive": true,
    "instructions": "string",
    "incomingCallInstructions": "string",
    "maxIncomingCallDurationMinutes": 0,
    "maxOutgoingCallDurationMinutes": 0,
    "gatheringInformationOnIncomingCall": true,
    "createdAt": "2019-08-24T14:15:22.123Z",
    "updatedAt": "2019-08-24T14:15:22.123Z",
    "deletedAt": "2019-08-24T14:15:22.123Z",
    "userId": "string",
    "tools": [
        {
            "agentId": "string",
            "toolId": "string",
            "createdAt": "2019-08-24T14:15:22.123Z",
            "tool": {
                "id": "string",
                "name": "string",
                "description": "string",
                "instruction": "string",
                "toolType": "HTTP",
                "url": "string",
                "method": "GET",
                "headers": {
                    "Authorization": "Bearer token123",
                    "Content-Type": "application/json"
                },
                "mcpServerUrl": "string",
                "mcpServerHeaders": {},
                "mcpServerName": "string",
                "mcpToolName": "string",
                "codeLanguage": "PYTHON",
                "codeSource": "string",
                "codeTestCases": {},
                "inputSchema": {
                    "name": "string",
                    "type": "string",
                    "description": "string",
                    "children": [
                        {
                            "name": "query",
                            "type": "string",
                            "description": "Search query",
                            "validations": {
                                "required": true,
                                "min": 1,
                                "max": 100
                            },
                            "label": "Search Query"
                        },
                        {
                            "name": "category",
                            "type": "enum",
                            "description": "Category filter",
                            "enumValues": [
                                "news",
                                "weather",
                                "sports"
                            ],
                            "validations": {
                                "required": false
                            }
                        }
                    ],
                    "enumValues": [
                        "string"
                    ],
                    "validations": {
                        "required": true,
                        "min": 0,
                        "max": 0,
                        "regex": "string",
                        "custom": "string",
                        "default": "string"
                    },
                    "label": "string",
                    "calculatedField": {
                        "dependencies": [
                            "string"
                        ],
                        "formula": "string"
                    }
                },
                "isActive": true,
                "createdAt": "2019-08-24T14:15:22.123Z",
                "updatedAt": "2019-08-24T14:15:22.123Z"
            }
        }
    ],
    "accessToKnowledge": true,
    "knowledgeAccessMode": "NONE",
    "knowledgeAccessTags": [
        "string"
    ],
    "allowFollowUps": true,
    "followUpInstructions": "string",
    "includePrivateData": true,
    "useBusinessProfile": true,
    "useDetachedReceptionistProfile": true,
    "receptionistPreferredName": "string",
    "receptionistCompanyName": "string",
    "receptionistCompanyWebsite": "string",
    "receptionistCompanyDescription": "string",
    "receptionistCompanyIndustry": "string",
    "receptionistAddress": "string",
    "receptionistCityName": "string",
    "receptionistStateName": "string",
    "receptionistZipCode": "string",
    "receptionistTimezone": "string",
    "voice": "string",
    "modelName": {},
    "allowCallTransfer": true,
    "callTransferNumber": "string",
    "transferHours": {
        "MONDAY": [
            900,
            1730
        ],
        "TUESDAY": [
            900,
            1730
        ],
        "WEDNESDAY": [
            900,
            1730
        ],
        "THURSDAY": [
            900,
            1730
        ],
        "FRIDAY": [
            900,
            1730
        ]
    },
    "firstMessage": "string",
    "allowOutboundGreetingInterruptions": false,
    "enableVoiceExpressions": true,
    "closingPhrase": "string",
    "delayAcceptSeconds": 0,
    "voiceRecognition": "EN",
    "temperature": 0,
    "dataCollections": [
        {
            "dataIdentifier": "string",
            "description": "string",
            "dataType": "STRING",
            "id": "string",
            "createdAt": "2019-08-24T14:15:22.123Z",
            "updatedAt": "2019-08-24T14:15:22.123Z",
            "agentId": "string",
            "results": [
                {
                    "id": "string",
                    "dataCollectionId": "string",
                    "callId": "string",
                    "createdAt": "2019-08-24T14:15:22.123Z",
                    "updatedAt": "2019-08-24T14:15:22.123Z",
                    "dataValue": {
                        "property1": "string",
                        "property2": "string"
                    }
                }
            ]
        }
    ],
    "evaluations": [
        {
            "name": "string",
            "prompt": "string",
            "id": "string",
            "createdAt": "2019-08-24T14:15:22.123Z",
            "updatedAt": "2019-08-24T14:15:22.123Z",
            "agentId": "string",
            "results": [
                {
                    "id": "string",
                    "callId": "string",
                    "evaluationId": "string",
                    "createdAt": "2019-08-24T14:15:22.123Z",
                    "updatedAt": "2019-08-24T14:15:22.123Z",
                    "type": "SUCCESS",
                    "rationale": "string"
                }
            ]
        }
    ],
    "welcomingVoiceMailMessageForContacts": "string",
    "welcomingVoiceMailMessageForOthers": "string",
    "isVoiceMailAgent": false,
    "outgoingCallFlow": {
        "nodes": [
            {}
        ],
        "edges": [
            {}
        ]
    },
    "incomingCallFlow": {
        "nodes": [
            {}
        ],
        "edges": [
            {}
        ]
    },
    "voiceSpeed": 0.5,
    "incomingCallTypingSound": true,
    "incomingCallBackgroundSound": true,
    "outgoingCallBackgroundSound": true,
    "outgoingCallTypingSound": true,
    "allowIncomingSms": false,
    "incomingSmsInstructions": "",
    "autoRespondToSms": true,
    "smsResponseDelay": 1,
    "useSmsIncomingCallFlow": false,
    "postCallSmsMessage": "string",
    "allowRealtimeSms": false,
    "phoneNumbers": [
        {
            "id": "string",
            "createdAt": "2021-01-01T00:00:00Z",
            "updatedAt": "2021-01-01T00:00:00Z",
            "phoneNumber": "+1234567890",
            "country": "US",
            "isActive": true,
            "agent": {
                "id": "string",
                "name": "string"
            },
            "agentId": "123",
            "direction": "INCOMING",
            "isSharedOutbound": false,
            "provider": "TWILIO",
            "source": "RENTED",
            "readyToRelease": false,
            "markedReadyToReleaseAt": "2019-08-24T14:15:22.123Z",
            "markToDeleteAt": "2019-08-24T14:15:22.123Z",
            "lastBilledAt": "2019-08-24T14:15:22.123Z",
            "monthlyCost": "1.15",
            "isTestNumber": false
        }
    ],
    "emailAddress": {
        "address": "string",
        "status": "ACTIVE"
    },
    "requireDataConsent": false,
    "dataConsentText": "string",
    "enablePostCallActions": false,
    "postCallActionInstructions": "string",
    "behaviorPreset": "default",
    "strictSpamFilter": false,
    "valuableCallRule": "string",
    "overrideCallerId": "string"
}

Modified at 2026-07-23 18:02:16

Delete an agent

Reset an agent to dashboard defaults