Update Workflow

Base URL:

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

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

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

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

Request Method: PUT

This API modifies the different Enboarder workflow attributes e.g. employee details, manager details, hire start date, custom fields etc. If Workflow is not available or is already Complete or Cancelled API return error response.

NOTE: Partial updates can also happen using this API by just providing the information that needs to be updated. For example, if new hire start date needs to be updated then invoke this API with externalid and nhstdt (and custom fields if multiple workflows exists with same external id) only.

Sample Request:

{
"externalid": “687368798490”,
"nhstdt": "2020-06-12"
}

Attribute Names & Descriptions:

externalid

Reference of external System to match with Enboarder Workflow. This should be unique for all workflows started in Enboarder. If external is not specified then Enboarder generates a unique ID for workflow, which can be used to perform update operations on Enboarder workflow programatically.

Required

nhnm

Updated full name of Employee

Optional

nhmob

Updated Employee Mobile

Optional

nheml

Updated Employee Email

Optional

chnl

Updated preferred channel for employee

Optional

managers

Updated manager details

Optional

manager.nm

Updated name of the manager

Optional

manager.mob

Updated mobile of the manager

Optional

manager.eml

Updated email of manager

Optional

manager.chnl

Updated preferred channel for manager

Optional

manager.mgrlbl

Label of manager, whose details need to be uodate. This is required in case of workflow has multiple variable managers

Optional

nhstdt

Updated Start Date of Employee

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?