ORorshot
Workflows

Update Workflow

Changed on

Update a workflow's steps, status or details

Available only to Enterprise-plan workspaces and first-party clients.

patch/workflows/{id}

Request

  • Base URL
    https://api.orshot.com/v1
  • URL
    https://api.orshot.com/v1/workflows/{id}
  • Auth
    HTTP bearer

Path parameters

idinteger required

The unique ID of the workflow

Request body

namestring

New name, up to 200 characters

descriptionstring

New description

statusstring

draft, active, paused or archived. Activating enforces the same rules as create

metadataobject

Merged into the stored metadata. Server-managed keys (health, poll, share, schema) are ignored

Response

Successful response

object required

Changes

  • a0c2c3003dc0Revision changes
    • info

      added the non-success response with the status

  • b2284a52aaadRevision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status