PATCH
/
api
/
v1
/
workflows
/
{workflowUniqueIdentifier}
{
  "uid": "<string>",
  "uniqueIdentifier": "<string>",
  "name": "<string>",
  "version": 123,
  "triggerEvent": {
    "uid": "<string>",
    "description": "<string>",
    "eventName": "<string>",
    "source": "platform_app",
    "schema": {},
    "metadata": {}
  },
  "filters": {},
  "annotations": [
    "<string>"
  ],
  "workflowDefinition": [
    {
      "stepIdentifier": 123,
      "activity": {
        "uniqueIdentifier": "<string>",
        "autoUpgradeToLatestVersion": true,
        "version": 123
      },
      "input": {},
      "retryPolicy": {
        "maximumAttempts": 123,
        "initialInterval": 123,
        "backoffCoefficient": 123
      },
      "onFailure": "ABORT",
      "executionTimeout": 123,
      "isSleepActivity": true,
      "dependencies": [
        "<string>"
      ],
      "requireApproval": true,
      "approverType": "USER",
      "approver": "<string>",
      "approvalTimeout": 123,
      "filters": {},
      "compensationActivity": {
        "activity": {
          "uniqueIdentifier": "<string>",
          "autoUpgradeToLatestVersion": true,
          "version": 123
        },
        "input": {}
      }
    }
  ],
  "executingAgent": "<string>",
  "isActive": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "teamId": "<string>",
  "metadata": {}
}

Path Parameters

​
workflowUniqueIdentifier
string
required

Body

application/json
​
name
string
required
​
triggerEvent
string
required
​
workflowDefinition
object[]
required
​
executingAgent
string
required
​
filters
object
​
annotations
string[]
​
teamId
string
​
metadata
object

Response

200
application/json
Operation successful
​
uid
string
required
​
uniqueIdentifier
string
required
​
name
string
required
​
version
number
required
​
triggerEvent
object
required
​
filters
object
required
​
annotations
string[]
required
​
workflowDefinition
object[]
required
​
executingAgent
string
required
​
isActive
boolean
required
​
createdAt
string
required
​
updatedAt
string
required
​
createdBy
string
required
​
teamId
string
required
​
metadata
object
required