Cancel Workflow

Base URL:

AU 🇦🇺 : https://my.enboarder.com

EU 🇪🇺 : https://eu.enboarder.com

US 🇺🇸 : https://us.enboarder.com

API Endpoint : {{baseURL}}/restapi/v1/cancelwf

Request Method: POST

This API Cancels Enboarder workflow. If Workflow is not available or is already Complete or Cancelled API return error response.

Sample Request:

{
"externalid": "ENB-494398793433",
"comments": "Employee has voluntarily terminated”,
“mode”: “ALL”
}

Attribute Names & Descriptions:

externalid

Identifier that uniquely identifies an instance of running Workflow in Enboarder

Required

comments

any additional comments for cancellation of workflow

Optional

mode

Determines workflow to cancel. Multiple workflows can be launched with same externalid but with different criteria, so while cancelling specific workflow can be cancelled by providing specific criteria and mode as SELECTED. Possible values are:

ALL (Default): All workflows for the externalid will be cancelled. All Workflows must be either in Pending, InProcess, Cancel or Deleted state.

SELECTED: Specific workflow with matching criteria will be cancelled.

CANCEL_ALL: All workflows for the external which are in PENDING or INPROGRESS state will be canceled, rest will be ignored.

Optional

customfields

List of all custom fields for the workflow. They are name , value pairs. name should match the name of custom field defined in Enboarder. Brand, location and optional categories can also be provided in custom fields with name as ‘brand’, ‘location’ and category name in Enboarder respectively.

Optional


Did this answer your question?