Skip to main content
PUT
/
api
/
v1
/
insights
/
workflows
/
{workflow_id}
/
inactivate
Typescript (SDK)
import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.insights.workflows.inactivate({
    workflowId: 248768,
  });

  console.log(result);
}

run();
{
  "name": "<string>",
  "source": "<string>",
  "description": "<string>",
  "insight_tool_ids": [
    123
  ],
  "conditions": {
    "min_duration": 120,
    "max_duration": 600,
    "sample_rate": 0.1,
    "agent_list": [
      866324,
      826325
    ],
    "prompt_list": [
      "123324"
    ],
    "folder_list": [
      16754,
      67535
    ],
    "sheet_info": {
      "sheet_id": "1AGOCYz05AZYYOMzow2EYlgdDXSXaWIhyA3-zCxBm4go",
      "sheet_name": "Q1 Sales Data"
    }
  },
  "id": 123,
  "insight_tools": [
    {
      "name": "<string>",
      "description": "<string>",
      "version": 123,
      "tool_arguments": "<unknown>",
      "insight_tool_definition_id": 123,
      "id": 123,
      "last_updated_by": "<string>",
      "insight_tool_definition": {
        "id": 123,
        "name": "<string>",
        "type": "<string>",
        "description": "<string>",
        "tool_parameters": "<unknown>",
        "tool_result_set": "<unknown>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "status": "<string>",
  "estimate": {
    "backfill_count": 123,
    "backfill_duration": 123,
    "estimated_daily_count": 123,
    "estimated_daily_duration": 123,
    "estimated_daily_cost": 123,
    "estimated_backfill_cost": 123
  },
  "last_updated_by": "<string>",
  "start_datetime": "2025-12-16T00:00:00Z",
  "end_datetime": "2025-12-17T00:00:00Z",
  "queue_count": 10,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Syllable-API-Key
string
header
required

Path Parameters

​
workflow_id
integer
required

Response

Successful Response

Response model for an insight workflow.

​
name
string
required

Human-readable name of insight workflow

Example:

"summary-workflow"

​
source
string
required

Source of the workflow

Examples:

"agent"

"transfer"

"upload"

"sheet"

"manual"

​
description
string
required

Text description of workflow

Example:

"Default workflow - generates a summary of the call"

​
insight_tool_ids
integer[]
required

Ordered list of IDs of tool configurations to be executed in the workflow

Example:
[1]
​
conditions
InsightWorkflowCondition · object
required

Conditions (filters) on which a workflow should be triggered.

​
id
integer
required

Internal ID of the insight workflow

Example:

1

​
insight_tools
InsightToolOutput · object[]
required

List of insight tool configurations used in the workflow

​
status
string
required

Status of the insight workflow

Examples:

"ACTIVE"

"INACTIVE"

​
estimate
InsightWorkflowEstimate · object
required

Estimate of the number of calls that will be processed by the workflow and their cost

​
last_updated_by
string
required

Email of user who last updated Insight Workflow

Example:

"[email protected]"

​
start_datetime
string<date-time> | null

Target session timestamp the workflow (backfill) should start. An empty value indicates start on activation - live sessions only

Example:

"2025-12-16T00:00:00Z"

​
end_datetime
string<date-time> | null

Target session timestamp the workflow (backfill) should end. An empty value indicates no end, i.e., include live sessions until deactivation

Example:

"2025-12-17T00:00:00Z"

​
queue_count
integer | null

Number of calls in the workflow queue (pending or processing)

Example:

10

​
created_at
string<date-time>

Timestamp at which the insight workflow was created

Example:

"2025-12-16T00:00:00Z"

​
updated_at
string<date-time>

Timestamp of most recent update to the insight workflow

Example:

"2025-12-17T00:00:00Z"