Workflows
Starts workflow based on request body
Initiates a flow with a trigger type of WORKFLOW_MANUAL_START.
You application must be authorized to use the Manage Box Relay application scope within the developer console.
post/workflows/{workflow_id}/start
Path parameters
workflow_idstring required
The ID of the workflow.
Request body
Example request
{
"type": "workflow_parameters",
"flow": {
"type": "flow",
"id": "123456789"
},
"files": [
{
"type": "file",
"id": "12345678"
}
],
"folder": {
"type": "folder",
"id": "87654321"
},
"outcomes": [
{
"id": "17363629",
"collaborators": {
"type": "variable",
"variable_type": "user_list",
"variable_value": [
{
"type": "user",
"id": "636281"
}
]
},
"completion_rule": {
"type": "variable",
"variable_type": "task_completion_rule",
"variable_value": "all_assignees"
},
"file_collaborator_role": {
"type": "variable",
"variable_type": "collaborator_role",
"variable_value": "editor"
},
"task_collaborators": {
"type": "variable",
"variable_type": "user_list",
"variable_value": [
{
"type": "user",
"id": "636281"
}
]
},
"role": {
"type": "variable",
"variable_type": "collaborator_role",
"variable_value": "editor"
}
}
]
}Response
Starts the workflow.