Update workflow instance status
PATCH https://automation.8x8.com/api/v1/accounts/:accountId/definitions/:definitionId/workflows/:workflowId
Use this resource to control the state of a workflow instance. For example, you can suspend a workflow to be resumed later or terminate a workflow due to an error.
Request
Path Parameters
accountId stringrequired
Account id
definitionId stringrequired
Workflow definition id.
workflowId stringrequired
Workflow instance id.
Body
- suspend (suspends a workflow that is currently in progress)
- resume (resumes a currently suspended workflow)
- terminate (terminates the workflow. A terminated workflow cannot be resumed)
statusstring
List of commands available. Supported commands are
Possible values: [suspend, resume, terminate]
Workflow status successfully updated.
Request is invalid.
Schema
codeintegerrequired
Error code.
messagestringrequired
Description of the error.
errorIdstringrequired
Unique error id.
timestampstringrequired
Timestamp when the error occurred.
{
"code":0,
"message":"string",
"errorId":"string",
"timestamp":"string"
}
{
"code":1000,
"message":"Invalid definition id.",
"errorId":"2558ff83-c8db-4890-805e-ad64001857a1",
"timestamp":"2021-07-13T01:28:37.66Z"
}
Workflow instance or definition is not found.
Schema
codeintegerrequired
Error code.
messagestringrequired
Description of the error.
errorIdstringrequired
Unique error id.
timestampstringrequired
Timestamp when the error occurred.
{
"code":0,
"message":"string",
"errorId":"string",
"timestamp":"string"
}
{
"code":1300,
"message":"Definition 2aa9465e-dec7-4c3e-8fa6-bd168af9eaca not found.",
"errorId":"2558ff83-c8db-4890-805e-ad64001857a1",
"timestamp":"2021-07-13T01:28:37.66Z"
}
Source: https://developer.8x8.com/connect/reference/patch-workflow-instance · 8x8 CPaaS Developer Docs. Synced for support deflection.
Please sign in to leave a comment.
0 Comments