Update workflow

PATCH 
/workflows/:workflowId

Update a Workflow details; available as an Add-On Module

Request

Path Parameters

workflowId stringrequired

Workflow Identifier

Query Parameters

siteId string

Site Identifier

application/json

Body

required

name string

Workflow name

description string

Workflow description

status WorkflowStatus (string)

Status of the Workflow

Possible values: [ACTIVE, INACTIVE]

Responses

200

20. OK

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

message string

Result message

Example (from schema)

{
  "message": "string"
}

400

400 BAD REQUEST

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

errors

object[]

List of errors

Array [

key string

Error Key

error string

Error Message

]

Example (from schema)

{
  "errors": [
    {
      "key": "string",
      "error": "string"
    }
  ]
}

Loading...