Skip to main content
PUT
/
projects
/
{project_reference}
/
workflows
/
{workflow_id}
Update Workflow
curl --request PUT \
  --url https://api.veryfront.com/projects/{project_reference}/workflows/{workflow_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "version": "<string>",
  "schedulable": true
}
'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "target": "<string>",
  "source_path": "<string>",
  "source": "<string>",
  "version": "<string>",
  "schedulable": true,
  "source_only_reasons": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

​
project_reference
string
required
​
workflow_id
string
required

Workflow identifier

Query Parameters

​
source_target_kind
string
​
target_branch_id
string<uuid> | null

Body

application/json
​
description
string | null
​
version
string | null
​
schedulable
boolean

Response

Updated workflow document

​
id
string
required
​
name
string
required
​
description
string | null
required
​
target
string
required
​
source_path
string
required
​
source
string
required
​
version
string | null
required
​
schedulable
boolean
required
​
edit_mode
enum<string>
required
Available options:
structured,
source_only
​
source_only_reasons
string[]
required