Remove Participant from All Active Workflows

Remove a single user or single group from every active workflow in which it currently appears as a member of an eligible participant group. This request starts a job, and Vault returns a job_id. Use this ID to retrieve per-workflow outcomes with Retrieve Remove Participant from All Active Workflows Results. Organizations may use this endpoint in cases like offboarding, to remove a departing user from every active workflow they participate in.

Removing a participant changes participant-group membership only. It does not cancel or reassign tasks already assigned to (or accepted by) that user, those tasks remain assigned. The user can no longer accept available tasks in the group. To end a user's already accepted, in-progress task, use Cancel Task (canceltasks) or Reassign Task (reassigntasks) with the Initiate Workflow Actions on Multiple Workflows endpoint.

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

Headers

Name	Description
`Content-Type`	`application/json`
`Accept`	`application/json`

Body Parameters

Name	Description
`user_id` conditional	The user ID to remove. Supply exactly one of `user_id` or `group_id`.
`group_id` conditional	The Vault user group ID to remove. Supply exactly one of `user_id` or `group_id`.

Request

curl -X POST -H "Authorization: {AUTH_VALUE}" \
  -H "Content-Type: application/json" \
https://myvault.veevavault.com/api/v26.3/object/workflow/actions/removeparticipant \
  --data '{ "user_id": 2055 }'

Response

{
  "responseStatus": "SUCCESS",
  "data": {
    "job_id": 93701,
    "url": "/api/v26.3/services/jobs/93701",
    "results_url": "/api/v26.3/object/workflow/actions/removeparticipant/results/93701"
  }
}

Response Details

On SUCCESS, Vault returns a job_id. You can poll the job status with Retrieve Job Status, and once complete, obtain results from Retrieve Remove Participant from All Active Workflows Results.

If the user or group is not present in any active workflow, the job still completes successfully with no result rows.