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

Edit a workflow draft

Change the draft with a list of `ops`: add, update, move or delete nodes, and connect or disconnect them. The ops apply all together or not at all. You must send the `revision` from your last read. If you get `409 revision_conflict`, read the workflow again and retry. Secrets read back as `********`. Send them back unchanged to keep the stored value. This edits the draft only. Use `publishWorkflow` to make it live.

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

PATCH/workflows/
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).

Body
3 fields
·

The draft.revision from your last getWorkflow or edit.

No items yet.

Rename the workflow.

curl -X PATCH 'https://omnidim.io/api/v1/workflows/{workflow_id}' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{}'
Example response
synthetic
{
  "revision": "string",
  "issues": {
    "errors": [
      {
        "code": "string",
        "message": "string",
        "node": "string",
        "field": "string",
        "hint": "string"
      }
    ],
    "warnings": [
      {
        "code": "string",
        "message": "string",
        "node": "string",
        "field": "string",
        "hint": "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.

Request Body

application/json
revision*string

The draft.revision from your last getWorkflow or edit.

ops*
name?string

Rename the workflow.

Response body

application/json

Response Body

The ops were applied.

application/json
revision?string

The new revision. Use it for your next edit.

issues?

What validation found. Errors block publish. Warnings do not.

Was this page helpful?

Get a workflow

One workflow with its draft, status and `revision`. Call it before every edit to get the current `revision`. Use `view=structure` to see nodes and edges without config on a large workflow. Secrets read back as `********`.

Delete a workflow

Delete a workflow. Its published version stops running. This cannot be undone, so confirm with the user first. To stop it without deleting, use `deactivateWorkflow`.