BAbannerbear

Update a workflow

Changed on

Change metadata, inputs or steps. Each of inputs and steps is replaced wholesale when present and left alone when omitted, so renaming a workflow does not disturb its definition. Read the workflow first and send back the full array with your changes applied.

patch/workflows/{uid}

Request

  • Base URL
    https://api.bannerbear.com/v5
  • Auth
    HTTP bearer

Path parameters

uidstring required

Request body

namestring
descriptionstring nullable
tagsstring[]
inputsobject

Inputs the workflow accepts, keyed by name. Omit to leave the existing inputs untouched; send {} to clear them.

Response

Updated workflow

uidstring
namestring
descriptionstring nullable
tagsstring[]
inputsobject

Inputs this workflow accepts, keyed by name. Each value is { type, required }. url-typed inputs are validated as http(s) URLs when a run is created.

ui_write_access'owner_only' | 'team'
api_write_access'team' | 'owner_only' | 'nobody'

Who may run this workflow via the API

created_atstring date-time

Changes