Deactivate a workflow

Deactivate a workflow. Its live executions are paused and new enrollments are refused until it is activated again.

POST https://api.centerfy.ai/webhooks/inbound/workflows/:id/deactivate

Headers

Header	Required	Value	Description
`x-api-key`	Yes	your sub-account API key (cfy_…)	Authenticates the request; or use Authorization: Bearer `<key>`.

Path parameters

Name	Type	Required	Description
`id`	`string (uuid)`	Yes	The workflow id.

Example

curl -X POST "https://api.centerfy.ai/webhooks/inbound/workflows/{id}/deactivate" \
  -H "x-api-key: $CENTERFY_API_KEY"

import { CenterfyClient } from "@centerfy/sdk";

const centerfy = new CenterfyClient({ apiKey: process.env.CENTERFY_API_KEY! });

const result = await centerfy.workflows.deactivate("<workflowId>");
console.log(result);

centerfy workflows deactivate <workflowId>

MCP tool: centerfy_workflows_deactivate (see MCP server)

Response

{
  "status": "success",
  "changed": true,
  "workflow": {
    "id": "5a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
    "name": "New lead follow-up",
    "description": "Text and call new leads within 5 minutes",
    "folder_id": null,
    "folder_name": null,
    "trigger_type": "contact_created",
    "trigger_types": [
      "contact_created"
    ],
    "is_active": false,
    "deactivated_at": "2026-10-05T16:00:00.000Z",
    "created_at": "2026-09-20T10:00:00.000Z",
    "updated_at": "2026-10-05T16:00:00.000Z"
  }
}

Errors

404 — if the workflow is not in this sub-account.

Notes

Idempotent: changed is false if the workflow was already inactive. No request body.