Skip to documentation
Workflow Developer API

Update Developer Workflow

Update workflow metadata or an existing draft; published graphs are immutable.

PATCH/developer/v1/workflows/{definition_id}

Authorizations

Authorization
stringheaderrequired

Send your GenHealth credential as Bearer <YOUR_API_KEY>. This endpoint requires workflow:write for the authenticated organization. When body.status is set, workflow:publish is also required.

Headers

Accept
stringheader

Response media type. Use application/json for the current API.

Parameters

definition_idrequired
stringpath

Request body

Send an application/json request body. This body is required.

WorkflowDeveloperDefinitionUpdate
configobject<string, any> | null
descriptionstring | null
edgesarray<WorkflowEdgeSchema> | null
namestring | null
nodesarray<WorkflowNodeSchema> | null
routestring | null
statusstring | null
triggerOnly `webhook` and manual `config.run_fields` are active; other triggers are ignored. The server syncs `webhook` from the `webhook_trigger` node. Trigger-only updates leave it unchanged; missing or mismatched values fail closed until publish or a node-bearing update. `type: manual` fields: `key`, `label`, `type`, `required`, `default`. `key` is required and unique; `type`: `boolean`, `number`, `text` (default `text`); `required` defaults to false; `default` must match `type`. An `upload_trigger` uses `text`, `date`, `number` run-field types, distinct from manual. Max 50 fields; keys 128 chars; labels 200 chars. Invalid manual triggers are rejected; see `details[].msg` and `details[].loc`.object<string, any> | null

Responses

200Successful Response
WorkflowDefinitionResponse
_createdstring
_last_modifiedstring | null
active_version_idstring | null
capabilitiesWorkflowBuilderCapabilities
configobject<string, any> | null
created_bystring | null
created_by_emailstring | null
deletedboolean
422Validation Error
HTTPValidationError
detailarray<ValidationError>