Workflow

Handoff submission

Hands off existing submission to specified workflow. This endpoint is available to "Administrator" users only.

put/workflow/{workflowPath}/handoff

Request

Base URL
https://env.unqork.io/api/1.0
Auth
OAuth 2
Client credentials
Password
Token URLhttps://xyzfinancial.unqork.io/api/1.0/oauth2/access_token
TypeScript
https://skmtc.dev/unqork/apis/unqork-customer-api/docs/workflow/:workflowPath/handoff/put.ts
A function with typed inputs. Its response is checked against the schema.

workflowPathstring required

Path of the workflow to handoff submission

submissionIdstring required

ID of submission to use.

startNodestring

Path of the start node in handoff workflow. Default start node will be used when startNode is not provided.

Successfully handed off submission

submissionIdstring

ID of submission

workflowIdstring

ID of workflow after handoff

statestring

Current state of the submission

statusCode200

submissionobject

Submission data

No recorded changes to this operation across all 6 revisions of this API.