update_workflow

{
  "type": "object",
  "description": "Supply only the fields to change. Object/array fields are replaced whole. Pass null to clear an optional field. Renaming via title does not change the slug.",
  "properties": {
    "workflowId": {
      "type": "string",
      "description": "24-hex id of the workflow to update (from list_workflows or create_workflow). Required — the title property here is the NEW title for renames, never an identifier."
    },
    "environmentId": {
      "type": "string",
      "description": "Move the workflow to a different environment you own."
    },
    "title": {
      "type": "string",
      "maxLength": 120,
      "description": "Workflow title (shown on the dashboard)."
    },
    "promptTemplate": {
      "type": "string",
      "maxLength": 5000,
      "description": "The task the browser agent runs, written as a BROWSING RUNBOOK. Structure it as: `Goal:` — one sentence naming the outcome. `Ground rules (every stage, every turn):` — bullet invariants when the task needs them, e.g. work one item at a time — never batch; only record a figure you can read on screen this turn — if it is not shown record it as \"not stated\", never estimate; keep a running tally and restate it every turn (\"captured C items · written R rows\"). Then `Stage N — <Site name> (<https://url>)` — one section per website or phase, listing the concrete steps to take in the browser (open/navigate, click, read, capture, compare, flag) in the order a person would do them, each stage ending with `Done when: <verifiable completion condition>`. Finish with `Output —` stating exactly what to produce or deliver once the final tally is met, including what to say when there is no data (never fabricate a row). When a stage delivers per-recipient (message/email each customer), state the MATCHING RULE in that stage — the identifier shared by the source record and the destination recipient (e.g. the customer name exactly as written in the source, matched against the contact name) — and the no-match branch: skip it and report it, never deliver to a similarly-named near-match. Write the user's CONCRETE values (group names, URLs, numbers) directly into the text; use {{variables}} ONLY when the user explicitly wants a reusable template whose inputs change per run. A short single-site task can be just a Goal plus its steps. PURE TASK ONLY — never write memory bookkeeping into the prompt (no \"check memory\", \"record in memory\", \"store in memory\" steps): tracking is authored in memoryContract and WebRun applies it to every run automatically."
    },
    "shortDescription": {
      "type": "string",
      "maxLength": 500,
      "description": "One-line summary shown in workflow lists."
    },
    "triggerPhrase": {
      "type": "string",
      "maxLength": 200,
      "description": "Natural-language phrase that invokes this workflow in chat."
    },
    "useCaseTags": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 60
      },
      "description": "Categorisation tags."
    },
    "department": {
      "type": "string",
      "maxLength": 100,
      "description": "Free-text department label (e.g. \"inventory\")."
    },
    "trigger": {
      "type": "object",
      "description": "How the workflow is meant to be invoked (informational — see notes). Defaults to {type:'manual', source:'manual'}.",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "cron",
            "external",
            "manual"
          ]
        },
        "source": {
          "type": "string",
          "maxLength": 50,
          "description": "e.g. 'cron', 'manual', 'gmail', 'webhook', 'hubspot'"
        },
        "via": {
          "type": [
            "string",
            "null"
          ],
          "maxLength": 50,
          "description": "e.g. 'direct', 'n8n'"
        }
      }
    },
    "schedule": {
      "type": "object",
      "description": "Saved schedule setting. NOTE: record-only — the workflow does NOT run on a timer until deployed as a scheduled agent (dashboard or Telegram bot).",
      "properties": {
        "type": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "at",
            "every",
            "cron",
            null
          ]
        },
        "at": {
          "type": "string",
          "description": "ISO 8601 date-time (type \"at\")."
        },
        "interval": {
          "type": "number",
          "description": "Repeat interval in ms, min 60000 (type \"every\")."
        },
        "cron": {
          "type": "string",
          "description": "5-field cron expression (type \"cron\")."
        },
        "timezone": {
          "type": "string",
          "description": "IANA timezone for the schedule. Default UTC."
        }
      }
    },
    "startingUrl": {
      "type": "string",
      "maxLength": 2000,
      "description": "Page Chrome opens at the start of each run. Omit to let the prompt decide."
    },
    "timezone": {
      "type": "string",
      "maxLength": 60,
      "description": "IANA timezone for runs of this workflow (e.g. \"America/New_York\"). Leave unset to follow the proxy country."
    },
    "model": {
      "type": "string",
      "maxLength": 60,
      "description": "Model profile key. Omit for the account default."
    },
    "proxy": {
      "type": "object",
      "description": "Proxy for runs. {source:\"WebRun\", country?} or {source:\"custom\", type:\"http\"|\"socks\", host, port, username?, password?}. Custom passwords are encrypted at rest and never returned. Social/messaging workflows (WhatsApp, Telegram, Instagram, Facebook, X, LinkedIn, TikTok): set country to the country the user is in right now — recommend it and confirm the country with them first; a mismatch is the usual cause of refused logins and sessions that log out repeatedly, and a scheduled workflow re-hits it every run, so keep the country stable once set.",
      "properties": {
        "source": {
          "type": "string",
          "enum": [
            "WebRun",
            "custom"
          ]
        },
        "level": {
          "type": "string",
          "enum": [
            "system",
            "chrome"
          ]
        },
        "country": {
          "type": "string",
          "description": "2-letter ISO code or \"random\" (WebRun)."
        },
        "type": {
          "type": "string",
          "enum": [
            "http",
            "socks"
          ]
        },
        "host": {
          "type": "string"
        },
        "port": {
          "type": "number"
        },
        "username": {
          "type": "string"
        },
        "password": {
          "type": "string"
        }
      }
    },
    "outputType": {
      "type": "string",
      "enum": [
        "text",
        "structured",
        "structured_csv"
      ],
      "description": "Output contract: 'text' (default), 'structured' (JSON matching outputSchema), 'structured_csv' (rows for the outputSchema column names)."
    },
    "outputSchema": {
      "type": [
        "object",
        "array"
      ],
      "description": "JSON Schema object (outputType \"structured\") or array of column-name strings (outputType \"structured_csv\")."
    },
    "requiredFiles": {
      "type": "array",
      "description": "Per-run file attachments. Each row may name its own environmentId; ownership is enforced per-file at dispatch.",
      "items": {
        "type": "object",
        "properties": {
          "fileId": {
            "type": "string"
          },
          "originalName": {
            "type": "string"
          },
          "environmentId": {
            "type": "string",
            "description": "24-hex environment id the file lives in."
          },
          "size": {
            "type": "number"
          }
        },
        "required": [
          "fileId"
        ]
      }
    },
    "deployedPolicyId": {
      "type": "string",
      "maxLength": 24,
      "description": "Policy id to run under (must be owned by you)."
    },
    "reachOutMode": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "off",
        "guardrail_only",
        "full",
        null
      ],
      "description": "Proactive-chat policy for runs: 'off', 'guardrail_only', or 'full'. Omit (or pass null) to inherit the account default (MCP-initiated runs treat inherit as 'off')."
    },
    "memoryEnabled": {
      "type": "boolean",
      "description": "Persist per-workflow agent memory across runs (default true)."
    },
    "memory": {
      "type": "string",
      "maxLength": 10000,
      "description": "The agent's private notebook: shown to it at the start of every run, updated automatically after each run. Seed it ONLY with durable facts the next run must already know — the exact description of a target item (e.g. the specific picture to match), user preferences, known starting state — one short line per fact. Do NOT put task steps here (promptTemplate) or tracking rules here (memoryContract). Most workflows need no seed at all: the agent builds its own notebook as it runs."
    },
    "orchestrateFirst": {
      "type": "boolean",
      "description": "Discovery mode: one run gathers the WHOLE work list up front, later runs claim one item each."
    },
    "workListEnabled": {
      "type": "boolean",
      "description": "Advanced — set automatically when memoryContract is supplied; leave unset."
    },
    "listType": {
      "type": "string",
      "enum": [
        "static",
        "dynamic",
        "monitor"
      ],
      "description": "Advanced — defaults automatically ('monitor' when memoryContract is supplied); leave unset."
    },
    "policyOptedOut": {
      "type": "boolean",
      "description": "Opt this workflow out of the environment's default policy."
    },
    "conciergeNotify": {
      "type": "string",
      "maxLength": 50,
      "description": "Where the concierge announces results (e.g. 'Telegram', 'Slack', 'WhatsApp', 'Microsoft Teams', 'concierge')."
    },
    "templateVariables": {
      "type": "array",
      "description": "ONLY for explicitly dynamic workflows (the user asked for a reusable template): metadata for the {{variables}} used in promptTemplate (drives the dashboard fill-in UI). Omit entirely when the prompt carries concrete values.",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Must match a {{name}} in promptTemplate ([a-zA-Z0-9_])."
          },
          "label": {
            "type": "string"
          },
          "prompt": {
            "type": "string",
            "description": "Question to ask the user for this value."
          },
          "type": {
            "type": "string",
            "description": "e.g. 'text', 'keywords'"
          },
          "kind": {
            "type": "string",
            "description": "e.g. 'config'"
          },
          "required": {
            "type": "boolean"
          },
          "sampleValue": {
            "type": "string"
          }
        },
        "required": [
          "name"
        ]
      }
    },
    "variableValues": {
      "type": "object",
      "description": "ONLY for explicitly dynamic workflows: default values for {{variables}}, keyed by variable name. NOTE: applied only when triggering via MCP trigger_workflow (merged under caller-supplied variables); REST /trigger and bot triggers ignore this field.",
      "additionalProperties": {
        "type": "string"
      }
    },
    "flow": {
      "type": "object",
      "description": "Dashboard flow diagram: { trigger: {kind, phrase}, steps: [{ primary: {label, domain}, verb }] }."
    },
    "wizardPreset": {
      "type": "object",
      "description": "Dashboard wizard preset: { technology, useCases[], destination, destinationSub }."
    },
    "destination": {
      "type": "object",
      "description": "Result destination chip: { type, sub, description }. Types seen: 'custom-api', 'slack', 'sheets', 'email', 'messaging', 'telegram', 'crm'.",
      "properties": {
        "type": {
          "type": [
            "string",
            "null"
          ]
        },
        "sub": {
          "type": [
            "string",
            "null"
          ]
        },
        "description": {
          "type": "string"
        }
      }
    },
    "compatibleTools": {
      "type": "array",
      "description": "Sites/tools the workflow uses: [{ name, loginUrl, domain, role }].",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "loginUrl": {
            "type": "string"
          },
          "domain": {
            "type": "string"
          },
          "role": {
            "type": "string"
          }
        }
      }
    },
    "memoryContract": {
      "type": "object",
      "description": "How this workflow should behave and what it must remember between runs. REQUIRED whenever the task handles each thing once — new messages, forward once, skip anything already done. Write all three fields in plain English, addressed to the agent; the platform wires the tracking itself. Never write any of this into the prompt: the prompt says what to do, this says how to do it consistently. To explicitly disable tracking for a task that looks like it needs it, pass {mode:'none'}.",
      "properties": {
        "groundRules": {
          "type": "string",
          "maxLength": 1500,
          "description": "Standing rules the agent follows on every turn of every run: what it must never do, what counts as proof a step actually succeeded, what to do when something looks ambiguous, and any pacing or volume limits. Short bullets."
        },
        "memoryInstruction": {
          "type": "string",
          "maxLength": 1500,
          "description": "When a single item counts as finished, and what happens to everything else. State plainly what must be true before an item is considered done, what to do when the agent cannot tell whether a past item was done, and what happens to items left over at the end of a run."
        },
        "itemIdentity": {
          "type": "string",
          "maxLength": 300,
          "description": "What tells one item apart from another, and stays the same the next time the agent sees it. Use only details visible on screen — for example where it came from, who it is from, when it appeared, and its opening words — and say how to write it the same way every time."
        }
      }
    },
    "skills": {
      "type": "array",
      "description": "Workflow-scoped skill entries (dashboard shape).",
      "items": {
        "type": "object"
      }
    },
    "refineMessages": {
      "type": "array",
      "description": "Dashboard builder refinement thread rows: [{ role, content }].",
      "items": {
        "type": "object",
        "properties": {
          "role": {
            "type": "string"
          },
          "content": {
            "type": "string"
          }
        }
      }
    },
    "roiMinutesPerTask": {
      "type": [
        "number",
        "null"
      ],
      "description": "Minutes saved per run (dashboard ROI card)."
    },
    "roiHourlyRate": {
      "type": [
        "number",
        "null"
      ],
      "description": "Hourly rate for the ROI card."
    },
    "fileDeferred": {
      "type": "boolean",
      "description": "Dashboard flag: file selection deferred to run time."
    },
    "publicDraftId": {
      "type": "string",
      "maxLength": 64,
      "description": "Dashboard public-draft correlation id."
    }
  },
  "required": [
    "workflowId"
  ]
}