V3 Update Milestone Dates

patch

https://api.elliemae.com/encompass/v3/loans/{loanId}/milestones

Use this API to update milestone dates for a specified loan.

This API endpoint added with the 25.1 release of Encompass.

Usage Notes

You cannot edit the date for the “File Started” milestone.
You can only provide milestone ID and Start Date for each payload.
You can obtain milestone IDs with either the V3 Get Milestone Logs List API or the V3 Get Loan API.
If you set the mode to “Automatic” and you specify multiple milestone IDs in the request, then the start date for the subsequent milestones will get adjusted appropriately. For example, if you update the start date for milestone 2 and 6, then milestones 3, 4 and 5 will get adjusted based on the milestone 2 date provided, and milestones 7 onward get adjusted based on the date provided for milestone 6.
Milestone dates must remain in chronological order. For example, the date for milestone 3 cannot be less than the date for milestone 2.

Path Params

loanId

string

required

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

Query Params

action

string

Specify the action to perform on the milestones. At this time, the only supported value is UpdateDates.

mode

string

Specify the mode for the milestones. Possible values are the following:
- Automatic - Automatically calculates the dates based on the number of days in the milestone settings defined in the milestone template applied to the loan.
- Manual - Sets the milestone date individually for each milestone.
- Loan - Uses the mode that is configured in the loan (i.e., Manual Mode or Automatic). This is the default.

persistent

string

Indicate True if the calculated dates are saved in the loan. Default is True.

Body Params

Headers

Authorization

string

required

Bearer token.

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error

200OK