> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orgo.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a workflow

> Turn a workflow on or off, rename it, or set its settings, its computer and its time zone.

Changes what a workflow is set to, never its steps. Send only the fields you change. To change its steps, use [Replace a workflow’s steps](https://docs.orgo.ai/api-reference/workflows/replace.md).

Turning a workflow on sets up its start: a timed start is scheduled, and an app event is watched on the computer’s own sign-in of that app. When it can’t run yet, turning it on answers `422` with `code: "not_ready"` and a `to_fix` list, and nothing changes. Any other change that leaves it unable to run turns it off, and the answer says `turned_off: true`.

## Path parameters

**id** `string` *required*

The workflow’s id, like `morning-report`.

## Headers

**If-Match** `string`

The version you read. A newer version answers `409` with `code: "version_conflict"`.

**X-Agent** `string`

Who is writing, at most 30 characters, like `Claude Code`. The canvas names you on the change.

## Request body

**on** `boolean`

`true` to turn it on, `false` to turn it off.

**name** `string`

A new name, at most 40 characters. Its id doesn’t change.

**settings** `object`

What it asks for once, name to value, like `{ "channel": "sales" }`. Only the names you send change. `""` or `null` takes one out.

**computer** `string | null`

The UUID of the computer its steps run on, one of yours (from [List workspaces](https://docs.orgo.ai/api-reference/workspaces/list.md) or [Get workspace](https://docs.orgo.ai/api-reference/workspaces/get.md)). `null` or `""` takes it off. Picking one takes a key with Control write and AI write.

**time\_zone** `string`

An IANA zone its times and date words are read in, like `America/New_York`. A timed start needs one.

## Response

The workflow as kept, in the same shape [Get a workflow](https://docs.orgo.ai/api-reference/workflows/get.md) answers, with the new version in `version` and the `ETag` header. `turned_off: true` appears when this change turned it off.

## Example

```bash cURL theme={null}
curl -X PATCH https://www.orgo.ai/api/workflows/morning-report \
  -H "Authorization: Bearer $ORGO_API_KEY" \
  -H "Content-Type: application/json" \
  -d "{\"computer\":\"$COMPUTER_ID\",\"time_zone\":\"America/New_York\",\"settings\":{\"channel\":\"sales\"}}"

curl -X PATCH https://www.orgo.ai/api/workflows/morning-report \
  -H "Authorization: Bearer $ORGO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"on":true}'
```

```python Python theme={null}
import os, requests

r = requests.patch(
    "https://www.orgo.ai/api/workflows/morning-report",
    headers={"Authorization": f"Bearer {os.environ['ORGO_API_KEY']}"},
    json={"on": True},
)
if r.status_code == 422:
    print("Can’t run yet:", r.json()["to_fix"])
```

```javascript JavaScript theme={null}
const r = await fetch("https://www.orgo.ai/api/workflows/morning-report", {
  method: "PATCH",
  headers: { Authorization: `Bearer ${process.env.ORGO_API_KEY}`, "Content-Type": "application/json" },
  body: JSON.stringify({ on: true }),
});
```

Replace `$COMPUTER_ID` with the computer’s UUID.

### It can’t run yet (`422`)

```json theme={null}
{
  "error": "It can’t run yet. Fix these first.",
  "say": "It can’t run yet.",
  "code": "not_ready",
  "to_fix": ["Connect Slack"],
  "next": "Fix each item in to_fix: a step with PUT /api/workflows/morning-report, settings, the computer or the time zone with PATCH /api/workflows/morning-report. Then try again."
}
```

When the missing piece is an app to connect on its computer, the body also carries `needs`, the apps to connect.

## Errors

| Status | Code | When |
| - | - | - |
| `400` | `invalid_body` | A value of the wrong kind, or a `time_zone` that is not an IANA zone. |
| `400` | `invalid_computer` | A computer that isn’t one of yours, or one the key doesn’t reach. |
| `401` | | No key, or a key Orgo doesn’t know. |
| `403` | `key_permission` | A restricted key without Workflows write, or picking a computer (or turning on a workflow whose steps act on it) from a key without Control write and AI write. |
| `403` | `computer_key_held` | A restricted or expiring key, and the computer holds its own Orgo key. |
| `404` | `not_found` | No workflow by that id. |
| `404` | (no body) | Workflows aren’t open to your account. |
| `409` | `version_conflict` | `If-Match` names an older version. |
| `413` | `body_too_large` | The body is over 64 KB. |
| `422` | `not_ready` | It can’t run yet, so it was not turned on. `to_fix` says what to do. |
| `429` | `rate_limited` | Too many writes. Carries `Retry-After`. |
| `503` | | Orgo couldn’t verify the key because of a server-side fault. Retry. |


## OpenAPI

````yaml PATCH /workflows/{id}
openapi: 3.1.0
info:
  title: Orgo API
  description: >-
    Launch cloud computers that AI agents can control and interact with. Create
    workspaces, provision computers, and control them programmatically.
  version: 2.0.0
  contact:
    name: Orgo Support
    email: contact@orgo.ai
    url: https://orgo.ai
servers:
  - url: https://www.orgo.ai/api
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Support
    description: >-
      Orgo’s support agent, for programs: ask how to do something in Orgo and
      get an answer with full URLs and copyable commands.
  - name: Account
    description: >-
      Account capacity: how many computers an account may run, and adding or
      giving back more.
  - name: Agent accounts
    description: >-
      Accounts an AI agent makes for itself, and the claim link a person uses to
      take one over.
  - name: Clients
    description: >-
      Run Orgo for your clients from your own app: a workspace and scoped key
      each, billed to you or to them.
  - name: Workspaces
    description: Organize computers into named workspaces
  - name: Computers
    description: Provision and manage virtual computers
  - name: Computer Lifecycle
    description: Start, stop, and restart computers
  - name: Computer Actions
    description: Control mouse, keyboard, and execute commands
  - name: Screens
    description: >-
      More than one desktop on a single computer. Each screen is its own X
      server with its own cursor and window manager, so an agent working on one
      cannot disturb another.
  - name: Files
    description: Upload and download files
  - name: Templates
    description: Author, build, and launch reproducible computers from templates
  - name: Chat
    description: Run an agent on a computer through OpenAI-compatible chat completions.
  - name: Workflows
    description: >-
      Routines that run the same way every time: a start, then steps. Make them
      from plain words or lines, check them, run them and follow their runs (in
      preview).
paths:
  /workflows/{id}:
    patch:
      tags:
        - Workflows
      summary: Rename a workflow, turn it on or off, or set its settings
      description: >-
        Body: name, on, settings ({ "name": "value" }; "" takes one out),
        computer (the id of the computer its steps run on) and time_zone.
        Turning it on when it can’t run is 422 not_ready with to_fix, and
        nothing changes. Any other change that leaves it unable to run turns it
        off (turned_off: true). If-Match: <version> refuses it over a newer
        version (409 version_conflict).
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            pattern: ^[a-z0-9-]{1,60}$
          example: morning-report
        - name: If-Match
          in: header
          required: false
          schema:
            type: string
          description: The version you read (GET’s version, or its ETag).
        - name: X-Agent
          in: header
          required: false
          schema:
            type: string
            maxLength: 30
          description: Who you are, as the canvas names you (like Claude Code).
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWorkflow'
            example:
              'on': true
              settings:
                channel: '#sales'
      responses:
        '200':
          description: The workflow, as kept.
          headers:
            ETag:
              description: The version, quoted.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workflow'
              example:
                id: morning-report
                name: Morning report
                'on': true
                version: 4
                lines: >-
                  {"id":"a","kind":"start","title":"9:00
                  AM","sub":"Weekdays","name":"Morning report"}

                  {"id":"b","after":["a"],"kind":"agent","agent":"hermes","title":"Write
                  the report","task":"Write a short report on yesterday’s new
                  customers."}

                  {"id":"c","after":["b"],"kind":"app","app":"slack","title":"Post","where":"{channel}","message":"{report}"}
                settings: {}
                to_fix:
                  - Fill in channel
                problems:
                  - step: a
                    say: Fill in channel
        '400':
          description: >-
            A value of the wrong kind (invalid_body), or a computer that isn’t
            yours (invalid_computer).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowError'
        '401':
          description: Unauthenticated (with WWW-Authenticate and docs).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowError'
        '403':
          description: >-
            A key without Workflows access at this level (key_permission); a key
            that may not act on the workflow’s computer (key_permission: Control
            write and AI write, or computer_key_held).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowError'
        '404':
          description: >-
            No workflow (or run) by that id (not_found); a bare 404 with no body
            where Workflows are not open to the account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowError'
        '409':
          description: >-
            If-Match names an older version (version_conflict): the body carries
            the newest version and lines. Merge your change into them and send
            it again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowError'
        '413':
          description: >-
            The body is too large (body_too_large): at most 64 KB, 128 KB for a
            PUT, 32 KB for an answer.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowError'
        '422':
          description: >-
            It can’t run yet, so it was not turned on (not_ready, with to_fix
            and problems; needs lists apps to connect on its computer first).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowError'
        '429':
          $ref: '#/components/responses/RateLimited'
        '503':
          $ref: '#/components/responses/AuthUnavailable'
components:
  schemas:
    UpdateWorkflow:
      type: object
      properties:
        name:
          type: string
          maxLength: 40
        'on':
          type: boolean
        settings:
          type: object
          additionalProperties:
            type:
              - string
              - 'null'
          description: Only the names sent change; "" or null takes one out.
        computer:
          type:
            - string
            - 'null'
          description: >-
            The computer its steps run on (its UUID, from List workspaces or Get
            workspace); null takes it off.
        time_zone:
          type: string
          description: An IANA zone, like America/New_York.
    Workflow:
      type: object
      required:
        - id
        - name
        - 'on'
        - version
        - lines
        - settings
        - to_fix
        - problems
      properties:
        id:
          type: string
          pattern: ^[a-z0-9-]{1,60}$
        name:
          type:
            - string
            - 'null'
        'on':
          type: boolean
          description: Whether its start runs it. It is on only while it can run.
        version:
          type: integer
          description: Send it as If-Match on a write.
        lines:
          type: string
          description: >-
            The workflow, one JSON object per step, the start first
            (https://www.orgo.ai/workflows.md).
        settings:
          type: object
          additionalProperties:
            type: string
          description: What it asks for once, name to value.
        to_fix:
          type: array
          items:
            type: string
          description: >-
            What still has to be done before it can run, in the person’s words.
            Empty: ready.
        problems:
          type: array
          items:
            type: object
            properties:
              step:
                type: string
                description: 'The step it is on (empty: the whole workflow).'
              say:
                type: string
        turned_off:
          type: boolean
          description: This write left it unable to run, so it was turned off.
        dropped:
          type: array
          items:
            type: string
          description: What of the lines sent was left out or rewritten.
    WorkflowError:
      type: object
      required:
        - error
        - code
      properties:
        error:
          type: string
        code:
          type: string
        say:
          type: string
          description: The same, short, for a person.
        next:
          type: string
          description: The call that fixes it.
        to_fix:
          type: array
          items:
            type: string
        problems:
          type: array
          items:
            type: object
        version:
          type:
            - integer
            - 'null'
          description: 'version_conflict: the newest version.'
        lines:
          type:
            - string
            - 'null'
          description: 'version_conflict: the newest lines, to merge into.'
    RateLimited:
      type: object
      required:
        - error
        - code
        - limit
        - retry_after
      properties:
        error:
          type: string
          description: Which limit, in plain words, and when to try again.
        code:
          type: string
          const: rate_limited
        limit:
          type: string
          enum:
            - computer_create_per_minute
            - computer_create_per_hour
            - computer_create_per_day
            - computer_lifecycle_per_minute
            - computer_lifecycle_per_computer_per_minute
            - computer_control_per_minute
            - computer_control_per_computer_per_minute
            - chat_runs_per_minute
            - chat_runs_concurrent
            - workspace_create_per_hour
            - api_other_per_minute
        retry_after:
          type: integer
          minimum: 1
          description: Seconds to wait.
      example:
        error: >-
          Too many API requests this minute (120 a minute on your plan). Try
          again in 12 seconds.
        code: rate_limited
        limit: api_other_per_minute
        retry_after: 12
    Error:
      type: object
      description: >-
        The base error body. Every failure carries `error`; individual endpoints
        add the fields named in the schemas below.
      required:
        - error
      properties:
        error:
          type: string
          description: Human-readable message.
          example: Access denied
        code:
          type: string
          description: >-
            Machine-readable reason. Present on the failures that define one,
            absent otherwise.
  responses:
    RateLimited:
      description: >-
        Over one of the account's plan rate limits (`rate_limited`): `limit`
        names it, and `retry_after` and `Retry-After` say how many seconds to
        wait. Limits are per account, the workspace owner's when the request
        acts on a computer or a workspace, and set by its plan. See [Account
        limits and rate limits](/guides/account-limits#plan-rate-limits).
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimited'
    AuthUnavailable:
      description: >-
        Orgo could not verify the credential because of a server-side fault,
        such as a database outage. Retry after `Retry-After`. Do not rotate the
        key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: >-
              Service temporarily unavailable. The database is not accepting
              requests. Retry shortly.
      headers:
        Retry-After:
          description: Seconds to wait before retrying. Always `5`.
          schema:
            type: string
            example: '5'
  headers:
    RetryAfter:
      description: Seconds to wait before asking again.
      schema:
        type: integer
        minimum: 1
    RateLimitLimit:
      description: The tightest limit this request counts against.
      schema:
        type: integer
    RateLimitRemaining:
      description: How many are left of it in this window.
      schema:
        type: integer
    RateLimitReset:
      description: Seconds until its window starts again.
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key authentication. Get your key at orgo.ai/workspaces

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.