POST Agents/Workflow/RemoveParticipantsFromEmailFlow

Some tooltip text!

• 1 minute to read

 • 1 minute to read

POST /api/v1/Agents/Workflow/RemoveParticipantsFromEmailFlow

Remove participants (actually workflow instances) from the workflow

Query String Parameters

Parameter Name	Type	Description
$select	string	Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

POST /api/v1/Agents/Workflow/RemoveParticipantsFromEmailFlow?$select=name,department,category/id

Request Headers

Parameter Name	Description
Authorization	Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN	If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type	Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
Accept	Content-type(s) you would like the response in:
SO-AppToken	The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: request

EmailFlowId, WorkflowInstanceIds

Property Name	Type	Description
EmailFlowId	Integer
WorkflowInstanceIds	Array

Response:

No Content

Response	Description
204	No Content

Response body: TimeZoneData

Sample request

POST /api/v1/Agents/Workflow/RemoveParticipantsFromEmailFlow
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

{
  "EmailFlowId": 410,
  "WorkflowInstanceIds": [
    604,
    158
  ]
}

Sample response

HTTP/1.1 204 No Content
Content-Type: application/json; charset=utf-8

null