Initiate Cancel Action on Multiple Workflows

Use this request to initiate the cancel action on multiple workflows. This starts an asynchronous job whose status you can check with the Retrieve Job Status endpoint. Maximum 500 workflows per request.

POST/api/{version}/object/workflow/actions/{action}

Headers

Name	Description
`Content-Type`	`application/x-www-form-urlencoded`
`Accept`	`application/json` (default) or `application/xml`

URI Path Parameters

Name	Description
`action`	The name of the workflow action. To get this value, Retrieve Bulk Workflow Actions. In API v20.2, only `cancelworkflows` is supported.

Body Parameters

Name	Description
`workflow_ids`	Input a comma-separated list of `workflow_id__v` field values. Maximum 500 workflows.

Request

curl -L -X POST '\ -H 'Authorization: {SESSION_ID}' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'workflow_ids=2903,2904,2905' \
https://myvault.veevavault.com/api/v20.2/object/workflow/actions/cancelworkflows'

Response

{
   "responseStatus": "SUCCESS",
   "data": {
       "job_id": 93601
   }
}

Response Details

On SUCCESS, the response returns the job_id for the action, and the authenticated user will receive an email notification with details of any failures that occur.