Update Workflow

Updates metadata or the draft graph for a workflow the API key user can edit. Updating the draft does not publish a new version. Send either metadata (including limits) or a graph update in one request. Do not mix them.

Base URL

https://api.langdock.com/workflows/v1/update

Dedicated deploymentsReplace api.langdock.com with <your-deployment-url>/api/public in all requests.

Required scopes

This endpoint requires the WORKFLOW_WRITE_API scope (Workflow Write API) and editor access.

Parameters

Parameter	Type	Required	Description
`workflowId`	string	Yes	UUID of the workflow.
`name`	string	No	Workflow name. Maximum: 60 characters.
`description`	string	No	Workflow description. Maximum: 500 characters.
`status`	string	No	`ACTIVE` or `INACTIVE`. `ACTIVE` requires a published version. Use `INACTIVE` to pause a live workflow.
`timezone`	string	No	Valid IANA timezone. Stored when `status` is omitted or `ACTIVE`. Ignored when `status` is `INACTIVE` so a pause does not overwrite the scheduled cron timezone.
`nodes`	array	No	Full draft node replacement. Must be sent together with `edges`, and not with `patch` or metadata.
`edges`	array	No	Full draft edge replacement. Must be sent together with `nodes`.
`patch`	object	No	Incremental graph operations instead of a full `nodes` and `edges` replacement. Cannot be sent with `nodes` and `edges` or with metadata.
`limits`	object	No	Execution caps with the same fields and ranges as create. Omitted fields stay unchanged. Send `null` on a field to clear it. May be sent with other metadata, not with a graph update. `monthlyCostUsd` cannot exceed the workspace Maximum monthly limit (USD) and cannot change when Settings shows Limit set by workspace admin.

To replace the draft graph, send both nodes and edges. To apply an incremental graph edit, send patch. Sending a redacted secret value from get keeps the stored secret. Send a new non-empty value to rotate a secret, or null to clear a secret-named field.

Example

const axios = require("axios");

async function pauseWorkflow(workflowId) {
  const response = await axios.patch(
    "https://api.langdock.com/workflows/v1/update",
    {
      workflowId,
      status: "INACTIVE"
    },
    {
      headers: {
        Authorization: "Bearer YOUR_API_KEY",
        "Content-Type": "application/json"
      }
    }
  );

  console.log("Status:", response.data.workflow.status);
}

pauseWorkflow("550e8400-e29b-41d4-a716-446655440000");

Response format

Success response (200 OK)

{
  status: "success";
  message: "Workflow updated successfully";
  workflow: object;
}

workflow matches the object on Workflow API Overview.

Error handling

Status code	Description
400	Invalid body, mixed graph and metadata, `nodes` without `edges`, no fields, activate without a published version, or a limit out of range, above the workspace monthly maximum, or locked by an admin
401	Invalid or missing API key
403	Missing `WORKFLOW_WRITE_API` scope or editor access. A missing workflow, a template, or a workflow in another workspace also returns this status. A Meeting End graph write without Meetings returns `MEETINGS_FEATURE_FLAG_DISABLED`.
429	Rate limit exceeded
500	Internal server error

Langdock intentionally blocks browser-origin requests to protect your API key and ensure your applications remain secure. For more information, please see our guide on API Key Best Practices.

Overview

Completion API

Embedding API

Agents API

Integrations API

Skills API

Knowledge Folder API

Prompt Library API

Usage Export API

Workflow API

Scheduled Tasks API

User Management API

Billing API

Audit Logs API

Governance API

Compliance API

Update Workflow

Base URL

Required scopes

Parameters

Example

Response format

Success response (200 OK)

Error handling

​Base URL

​Required scopes

​Parameters

​Example

​Response format

​Success response (200 OK)

​Error handling

Base URL

Required scopes

Parameters

Example

Response format

Success response (200 OK)

Error handling