Update workflow definition

PATCH/api/v1/workflows/{id}

Updates metadata, code, config, or UI for a workflow definition.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?nonEmptyString

a non empty string

Length1 <= length

description?string|null

code?nonEmptyString

a non empty string

Length1 <= length

config?

ui?

Response Body

`application/json`

curl -X PATCH "https://loading/api/v1/workflows/{id}" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "8ac68d1e-9d8b-49e8-b31d-5fcd0d214f18",
  "name": "Document validation",
  "handle": "document-validation",
  "url": "/w/acme-growth-team/workflows/document-validation-8ac68d1e-9d8b-49e8-b31d-5fcd0d214f18/config",
  "description": "Validates inbound documents and drives the review flow.",
  "code": "export async function run({ input, config, ui }) {\n  return { ok: true, input, config, ui };\n}",
  "version": 2,
  "config": {
    "retries": {
      "maxAttempts": 3
    }
  },
  "ui": {
    "stateLabels": {
      "draft": "Draft",
      "validating": "Validating"
    }
  },
  "createdAt": "2026-04-21T12:00:00.000Z",
  "updatedAt": "2026-04-21T12:00:00.000Z"
}

{
  "issues": [
    {
      "_tag": "Pointer",
      "path": [
        "string"
      ],
      "message": "string"
    }
  ],
  "message": "string",
  "_tag": "HttpApiDecodeError"
}

{
  "code": "authentication_required",
  "message": "Authentication required. Send Authorization: Bearer <api-key>, x-api-key, or a signed-in session."
}

{
  "code": "insufficient_permissions",
  "message": "This API key does not have the required permission.",
  "details": {
    "requiredPermission": "resource.action"
  }
}

{
  "code": "not_found",
  "message": "The requested resource was not found."
}

{
  "code": "internal_error",
  "message": "An unexpected server error occurred."
}

Update workflow definition

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`