Upgrade a workflow

PUT 
/workflows/:workflowId/upgrade

This endpoint allows you as the ISV to upgrade the workflow for a specified end user.

In order to upgrade a workflow via this endpoint, the new workflow must have the same configurable fields as the original. If any new configurable fields were added, you will not be able to upgrade the workflow programmatically and instead would need to reinstall the workflow for the end user.

Request

Path Parameters

workflowId stringrequired

Id of the parent workflow in which you are upgrading for the end user

Query Parameters

userId stringrequired

Id of the end user you wish to upgrade the workflow for

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

upgraded boolean

Default value: true

Example (from schema)

{
  "upgraded": true
}

Result

{
    "upgraded": true
}

400

400

application/json

Schema

Schema

object

Example (from schema)

{}

Result

{}

Loading...