Update / publish / archive a workflow.

Authorization

AuthorizationBearer <token>

Rensei API key presented as Authorization: Bearer rsk_live_. Required API-key scopes are recorded per operation in x-rensei-required-scopes.

In: header

Path Parameters

id*string

Workflow id.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

description?string|null

status?string

Value in"configuring" | "draft" | "published" | "archived"

confirmUnpublish?boolean

Required to flip a published workflow back to draft.

nodes?array<unknown>

edges?array<unknown>

groups?array<unknown>

viewport?unknown

projectScope?array<string>

Response Body

`application/json`

curl -X PUT "https://example.com/api/workflows/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "string",
  "workspaceId": "string",
  "name": "string",
  "description": "string",
  "status": "string",
  "nodes": [
    null
  ],
  "edges": [
    null
  ],
  "groups": [
    null
  ],
  "viewport": null,
  "definitionYaml": "string",
  "createdBy": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "publishedAt": "string",
  "projectScope": [
    "string"
  ],
  "archivedAt": "string"
}

Empty