workflows

Update a workflow

put/workflows/{id}

Request

  • Base URL: https://api.onplana.com/api
  • URL: https://api.onplana.com/api/workflows/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Path parameters

idstring required

Headers

X-Organization-Idstring required

UUID of the active organization. Sets org context for all scoped operations.

Request body

object required

Partial update.

Response

Updated

idstring uuid required
namestring required
descriptionstring nullable
organizationIdstring uuid required
projectIdstring uuid nullable

null = org-wide; set = scoped to one project.

isActiveboolean required
graphobject required

Directed graph of conditions, actions, approval steps, and delays. See the Workflow Builder UI for the canonical shape.

scheduleobject nullable

Cron-style schedule for time-triggered workflows.

runCountinteger
maxRunsinteger nullable
lastRunAtstring date-time nullable
createdByIdstring uuid
createdAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.