Tasks Bulk Update

patch

https://api.elliemae.com/workflow/v1/tasks/bulk

The Tasks Bulk Update API allows users to update multiple fields with different values for each field for a subset of workflow tasks.

Usage Notes

The usage of this API is restricted to Encompass users with an administrator or super administrator persona.
Only a non-completed task is allowed to be updated.
If one task fails to update, it does not block other tasks (if any attribute in a task array fails the entire array will fail).
A maximum of 50 tasks could be modified per API call and they don't need to be in the same loan.
Changes triggered through this API will continue to appear in the task change webhook.

Query Params

action

string

Action to be performed on these tasks. Available values: update. Defaults to update.

Body Params

assignee

object

Use data provided in the entityRef contract.
Note: This attribute triggers task business logic processing. Updating assignee may also change the start date of the task.

autocomplete

boolean

Flag to indicate if the task entity will be marked complete if all required sub tasks under the entity are completed.

description

string

Description of task.

string

System generated id of a task.

name

string

Name of a task.

priority

integer

Priority of a task. Must be a positive number greater than or equal to 1.

required

boolean

Indicates if a task is required. If the Auto-Complete flag is set to true for the specific task, all “Required” child tasks must be completed before the parent task can be completed.

resolution

string

Disposition of the task.
The values must align with the Disposition Configuration in the Global Task Settings of Encompass Web.

resolutionComment

string

Disposition comment of the task.

Headers

Authorization

string

required

Bearer token

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

200OK