V1 Update a Milestone

patch

https://api.elliemae.com/encompass/v1/loans/{id}/milestones/{logId}

Updates the specified milestones for a loan.

Path Params

string

required

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

logId

string

required

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

Query Params

action

string

Specify the action to perform on the milestone. To complete a milestone, use finish action. To re-open the milestone, pass unfinish.

Body Params

string

Unique identifier of the milestone.

startDate

string

The start date of the milestone.

comments

string

Indicates information related to the milestone. It displays comments that have been recorded for this loan. Comments are grouped by milestone.

loanAssociate

object

Object containing loan associate details. [See Loan Associate Attributes](ref: v1-contracts-6#associate)

expectedDays

integer

The expected number of days to finish the milestone.

doneIndicator

string

Indicates whether the milestone has been completed.

actualDays

string

Indicates the number of days to complete the milestone.

milestoneIdString

string

Unique entity ID of the milestone.

reviewedIndicator

boolean

Indicates whether all activities or documents related to the milestone have been reviewed.

roleRequired

boolean

Specifies whether assigning a loan team member to this milestone is required.

milestoneName

string

Name of the milestone set by the Encompass administrator.

Headers

Authorization

string

required

Bearer token.

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error