V1 Update a Milestone-Free Role

Updates the specified milestone-free role for a loan.

Path Params
string
required

The loan ID, which is the unique identifier assigned to the loan.

string
required

The milestone-free log ID. The log ID can be obtained from the response of Get All Milestones

Body Params
string

Loan associate type can be user or group. This attribute is required when associating a user to a milestone or milestone-free role.

string

Encompass user ID. This attribute is required when associating a user to a milestone or milestone-free role.

string

Name of the loan associate. The associate name cannot be updated. It will be extracted from the user’s profile when associating the user to milestone or milestone-free role.

string

Phone number of the loan associate. The phone number cannot be updated. It will be extracted from the user’s profile when associating the user to milestone or milestone-free role.

string

Cell phone number of the loan associate. The cell phone number cannot be updated. It will be extracted from the user’s profile when associating the user to milestone or milestone-free role.

string

Fax number of the loan associate. The fax number cannot be updated. It will be extracted from the user’s profile when associating the user to milestone or milestone-free role.

string

Email address of the loan associate. The email address cannot be updated. It will be extracted from the user’s profile when associating the user to milestone or milestone-free role.

string

Role name of the milestone or milestone-free role. This is a read-only attribute.

Although Encompass allows for the creation of custom roles, there are four “fixed” role names defined in Encompass:
Loan Officer

Loan Processor

Loan Closer

Underwriter

Custom roles can be mapped to a fixed role in Encompass.

integer

Role Id associated with the milestone or milestone-free role. This is read only attribute.

string

Write access indicator of the milestone or milestone-free role. This is a read-only attribute.

Headers
string
required

Bearer token.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Language
URL
LoadingLoading…