Sign in

v3

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2021-08-208527.2 KB
templates

Update an existing flow template

The id is used to match the existing Flow Template that will be updated. Requires the 'flowTemplates.write' permission.

patch/templates/{id}

Path parameters

idstring string required

ID of flow template to update

Request body

namestring required
descriptionstring
type'ordinary' | 'realtime' required

Flow type

cronstring

A cron string describing the interval at which this flow is run. If unset, the flow uses webhooks instead

Example request

{
  "name": "SnazzyToCodeComponent",
  "description": "This flow polls for persons and posts them on webhoo.site.",
  "graph": {
    "edges": [
      {
        "source": "step_1",
        "target": "step_2"
      }
    ]
  },
  "type": "ordinary",
  "cron": "* /2 * * * *"
}

Response

The updated Flow Template.

metaobject

Example response

{
  "data": {
    "name": "SnazzyToCodeComponent",
    "description": "This flow polls for persons and posts them on webhoo.site.",
    "graph": {
      "edges": [
        {
          "source": "step_1",
          "target": "step_2"
        }
      ]
    },
    "type": "ordinary",
    "cron": "* /2 * * * *",
    "status": "draft",
    "createdAt": "2019-07-30T12:52:45.957Z",
    "updatedAt": "2019-07-30T12:52:45.957Z"
  }
}