upgradeWorkflowItem

POST
Use dark colors for code blocksCopy
/{orgId}/admin/{itemId}/upgrade

Upgrades a Workflow Manager item

Upgrade an outdated Workflow Manager item. Workflow item upgrades can only be performed by the item owner with the Workflow Manager Advanced Administrator privilege or the Portal Admin Update Content privilege.

Query parameters

Name	Type	Required
`token`	`string¦null`

Body parameters

Supported content types: application/json

Type: CreateWorkflowItemParameters

Name	Type	Required
`async`	`boolean`

Path parameters

Name	Type	Required
`orgId`	`string`
`itemId`	`string`

Response status

Status	Meaning	Description	Schema
200	OK	The item upgrade status of the item being upgraded	CreateItemResponse
400	Bad Request	error	WorkflowJsonExceptionDTO

Examples

Request

Use dark colors for code blocksCopy
# You can also use wget
curl -X POST /{orgId}/admin/{itemId}/upgrade \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <YOUR_TOKEN>' \
  --data '{"async":true}'

Response

Use dark colors for code blocksCopy
{
  "success": true,
  "itemId": "string",
  "status": "Executing",
  "error": {
    "message": "string",
    "name": "UnableToDetermineHostingServer",
    "details": [
      "string"
    ]
  }
}