Skip to main content
PATCH
/
workflows
/
{id}
Update a workflow
curl --request PATCH \
  --url https://api.reelevant.com/v2/workflows/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "resourceGroupIds": [
    "<string>"
  ],
  "variableProfileId": "<string>",
  "hierarchy": [
    "<string>"
  ],
  "hidden": true,
  "metadata": {},
  "analyzeOverrides": {
    "vertexIndividualizedScore": {},
    "customVertexNames": [
      {
        "vertexId": "<string>",
        "name": "<string>"
      }
    ],
    "branchCategoryIds": {}
  },
  "changeDescription": "<string>"
}
'
{
  "status": "success",
  "program": "<string>",
  "version": "<string>",
  "datetime": "<string>",
  "message": "<string>",
  "data": {
    "_id": "<string>",
    "name": "<string>",
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "hierarchy": [
      "<string>"
    ],
    "archivedAt": "2023-11-07T05:31:56Z",
    "hidden": true,
    "integrations": [
      {
        "type": "web",
        "id": "<string>",
        "workflowId": "<string>",
        "shortId": "<string>",
        "domain": "<string>",
        "enabled": true,
        "includeContext": true,
        "includeDatalayerPath": [
          "<string>"
        ],
        "waitForEvents": [
          "<string>"
        ],
        "filters": {
          "type": "and",
          "conditions": [
            {
              "operator": "empty",
              "field": "<string>",
              "values": [
                "<string>"
              ]
            }
          ]
        },
        "code": "<string>",
        "selector": "<string>",
        "emplacement": "replace"
      }
    ],
    "companyId": "<string>",
    "resourceGroupIds": [
      "<string>"
    ],
    "versions": [
      {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "definition": {
          "nodes": {},
          "entrypoints": {},
          "edges": {}
        },
        "analyze": {
          "entrypointsByBranches": [
            {
              "branch": "<string>",
              "entrypointIds": [
                "<string>"
              ]
            }
          ],
          "branches": [
            "<string>"
          ],
          "individualizedBranches": [
            "<string>"
          ],
          "branchesScore": {},
          "defaultBranches": [
            "<string>"
          ],
          "usedDatasourceFields": {},
          "branchesInfos": {},
          "entrypointsPerDataNodeId": {},
          "entrypointsPerPathId": {},
          "entrypointTypes": [
            "<string>"
          ],
          "categoryIdByBranch": {},
          "outputsForEntrypoint": {},
          "datasForEntrypoint": {}
        },
        "metadata": {},
        "analyzeOverrides": {
          "vertexIndividualizedScore": {},
          "customVertexNames": [
            {
              "vertexId": "<string>",
              "name": "<string>"
            }
          ],
          "branchCategoryIds": {}
        },
        "lastSavedBy": "<string>",
        "changeDescription": "<string>",
        "complexityScore": 123
      }
    ],
    "description": "<string>",
    "variableProfileId": "<string>"
  },
  "code": 123
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
id
string
required
Pattern: ^[0-9a-fA-F]{24}$

Body

application/json
​
name
string
​
description
string
​
resourceGroupIds
string[]
​
variableProfileId
string

Variable profile id let frontend pre-select profile

​
hierarchy
string[]
​
hidden
boolean
​
metadata
object

This is used by the frontend to store their metadata (node positions...) like: { : { position: { x: ..., y: ... } } }

​
definition
object

Workflow definition

​
analyzeOverrides
object

Overrides configuration for the analyze

​
changeDescription
string

Description of whats have been changed by this version

Response

Ok

​
status
enum<string>
required
Available options:
success
​
program
string
required
​
version
string
required
​
datetime
string
required
​
message
string
required
​
data
object
required
​
code
number