MCP is live.Set upAsk the community
OmniDimension
Dashboard
DocumentationAPI referenceSDKsMCP
Workflows

Deactivate a workflow

Turn the published workflow off, so real events stop running it. The workflow and its draft stay. Use `activateWorkflow` to turn it back on.

Workflow builder. Included from the Jump Starter plan. See plans.

POST/workflows//deactivate
Path parameters
workflow_idrequired
Query parameters
user_idinteger

Reseller keys only: act as one of your clients by its user id. Omit it to act on your own account. [How acting for a client works](/docs/reseller/your-clients/acting-as-clients). 

curl -X POST 'https://omnidim.io/api/v1/workflows/{workflow_id}/deactivate' \
  -H 'Authorization: Bearer YOUR_API_KEY'
Example response
synthetic
{
  "workflow": {
    "id": 0,
    "name": "string",
    "status": "draft",
    "published_version_id": 0,
    "webhook_url": "string",
    "draft": {
      "version_id": 0,
      "revision": "string",
      "nodes": [
        {
          "id": "string",
          "type": "string",
          "label": "string",
          "position": {
            "x": 0,
            "y": 0
          },
          "config": "string"
        }
      ],
      "edges": [
        {
          "from": "string",
          "to": "string",
          "handle": "string"
        }
      ]
    }
  }
}

Authorization

BearerAuth
headerAuthorizationBearer <token>

Bearer token authentication. Obtain your API key from the OmniDimension dashboard.

Path Parameters

workflow_id*integer

Id of the workflow.

Query Parameters

user_id?integer

Reseller keys only: act as one of your clients by its user id. Omit it to act on your own account. How acting for a client works.

Response body

application/json

Response Body

The workflow is paused.

application/json
workflow?

Was this page helpful?

Activate a workflow

Turn the published workflow on, so real events run it. Use it to resume a workflow you paused with `deactivateWorkflow`.

Test a workflow

Runs the draft once with payload as the trigger data. Every node runs for real: WhatsApp messages, SMS, emails and calls go out and CRM records change. Ask the user before calling it, and use their own phone number or email in the payload. It returns an `execution_id` at once. Poll `getWorkflowExecution` for the result.