---
title: "PATCH /ver2/WorkflowService.svc/workflows/{workflowIdOrUniqueId}/steps/{stepIdOrName}"
method: PATCH
path: "/ver2/WorkflowService.svc/workflows/{workflowIdOrUniqueId}/steps/{stepIdOrName}"
tags: ["Workflow"]
---

# PATCH /ver2/WorkflowService.svc/workflows/{workflowIdOrUniqueId}/steps/{stepIdOrName}

`PATCH /ver2/WorkflowService.svc/workflows/{workflowIdOrUniqueId}/steps/{stepIdOrName}`

## Request

- Base URL: `https://api.enviance.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.enviance.com/ver2/WorkflowService.svc/workflows/{workflowIdOrUniqueId}/steps/{stepIdOrName}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/enviance/apis/restapi/docs/ver2/WorkflowService.svc/workflows/:workflowIdOrUniqueId/steps/:stepIdOrName/patch.ts> (a function with typed inputs; its response is checked against the schema)

Updates one or more values in the Form Fields of an existing Workflow Step. Any Form Fields *not* specified are left un-modified. A Step Action to invoke may also be specified, which will move (transition) the Workflow from the current Step to the destination Step of the Step Action.

**Security:** Allowed for Users with Manage Workflows right or "Report" permission on the Workflow, or User in "Workflow Managers" role of WF, or User with "Manage Workflows" on any objects associated with the workflow.

**SDK API:** `envianceSdk.workflows.updateWorkflowStep(workflowIdOrUniqueId, stepIdOrName, stepInfo, onsuccess, onerror)`

```
<div class="code">
<pre>
PATCH /ver2/WorkflowService.svc/workflows/7ef9655e-916b-414f-8c88-5753fa731558 HTTP/1.1
Content-Type: application/json; charset=UTF-8
 
{
  "workflowInfo": {
    "dueDate": "2012-09-19T18:00:00",
    "name": "test",
    "objects": ["/Generation - 1/NE TV"],
    "documents": ["/Folder/Folder/Doc.txt"]
  }
}

```



envianceSdk.workflows.updateWorkflowStep
```
[
  "22cf40b5-b001-47ce-8853-020dc9e9aa8e",
  "Oleg FT Step1",
  {
    "comment": "my comment",
    "transition": {
      "dueDate": "2013-02-15T00:00:00",
      "stepActionName": "Oleg FT Step1 Action1",
      "assignTo": [
        {
          "userIdOrName": "oleg"
        },
        {
          "userIdOrName": "vitek"
        },
        {
          "groupIdOrName": "Administrators"
        },
        {
          "groupIdOrName": "BL Group"
        }
      ]
    },
    "fields": [
      {
        "name": "Oleg FT 1 = dt date",
        "values": [
          "2013-02-01T00:00:00"
        ]
      },
      {
        "name": "Oleg FT 1 = url",
        "urlItems": [
          {
            "label": "may label",
            "url": "http://mail.ru"
          }
        ]
      },
      {
        "name": "oleg FT 1 = num ddl linked 2",
        "values": [
          "100",
          "100"
        ]
      },
      {
        "name": "oleg FT 1 = text multi",
        "values": [
          "val1",
          "val3"
        ]
      }
    ]
  },
  "onsuccess",
  "onerror"
]
```
envianceSdk.workflows.updateWorkflowStepExt
```
[
  {
    "workflowIdOrUniqueId": "22cf40b5-b001-47ce-8853-020dc9e9aa8e",
    "stepIdOrName": "Oleg FT Step1",
    "stepInfo": {
      "comment": "my comment",
      "transition": {
        "dueDate": "2013-02-15T00:00:00",
        "stepActionName": "Oleg FT Step1 Action1",
        "assignTo": [
          {
            "userIdOrName": "oleg"
          },
          {
            "userIdOrName": "vitek"
          },
          {
            "groupIdOrName": "Administrators"
          },
          {
            "groupIdOrName": "BL Group"
          }
        ]
      },
      "fields": [
        {
          "name": "Oleg FT 1 = dt date",
          "values": [
            "2013-02-01T00:00:00"
          ]
        },
        {
          "name": "Oleg FT 1 = url",
          "urlItems": [
            {
              "label": "may label",
              "url": "http://mail.ru"
            }
          ]
        },
        {
          "name": "oleg FT 1 = num ddl linked 2",
          "values": [
            "100",
            "100"
          ]
        },
        {
          "name": "oleg FT 1 = text multi",
          "values": [
            "val1",
            "val3"
          ]
        }
      ]
    },
    "clientRequestId": "64AA5290-15F2-451B-9EF3-4494F66FE59E"
  },
  "onsuccess",
  "onerror"
]
```

## Path parameters

- `workflowIdOrUniqueId` string, required
- `stepIdOrName` string, required

## Headers

- `EnvApi-Systemid` string
- `EnvApi-Packageid` string
- `EnvApi-Udf-DateTime-Iso-In-CustomFields` string
- `EnvApi-Udf-DateTime-ReadInUserTz` string
- `EnvApi-Udf-Value-Invariant` string
- `EnvApi-Localization-All` string
- `x-client-request-id` string

## Request body

- UpdateWorkflowStep
  - `stepInfo` EnvianceRestServicesVer2WorkflowsWorkflowStepInfo
    - `id` string, guid
    - `name` string
    - `comment` string
    - `fields` EnvianceRestServicesUdfsProperty[]
      - `name` string
      - `urlItems` EnvianceBusinessUdfRestUrlItem[]
        - `label` string
        - `url` string
      - `values` string[]
      - `beginDate` string, date-time
      - `endDate` string, date-time
      - `caption` string
      - `captionLocalized` string
    - `transition` EnvianceRestServicesVer2WorkflowsTransition
      - `stepActionName` string
      - `assignTo` EnvianceRestServicesCommonAssigneeV2[]
        - `userIdOrName` string
        - `groupIdOrName` string
      - `dueDate` string, date-time
      - `closeDate` string, date-time
    - `taskCompletion` EnvianceRestServicesVer2TasksTaskOccurrenceInfo[]
      - `statusChangeDate` string, date-time
      - `objectIdOrPath` string
      - `dismissed` boolean
      - `percentComplete` string, byte
      - `hoursToComplete` number, double
      - `costToComplete` number
      - `comment` string
      - `eventInstanceId` string, guid
      - `compliancePeriodStartDate` string, date-time
      - `compliancePeriodEndDate` string, date-time
      - `comply` string
      - `ObjectId` string, guid

## Response `default`

not available

---

[API](https://skmtc.dev/enviance/apis/restapi.md) - [All operations](https://skmtc.dev/enviance/apis/restapi/llms.txt) - [OpenAPI document](https://skmtc.dev/enviance/apis/restapi/revisions/45b2200a8cf2?raw)