V3 Update Milestone Log

Use this API to update a particular milestone log. User can pass milestone details in the payload and can also assign loan associate user using this API.

Path Params
string
required

Required. Unique identifier assigned to the loan.

string
required

The unique identifier for the milestone.

Query Params
string

The unique identifier for the lock.

boolean

Indicates changing the primary loan team member allowed.

string

Optional. View type parameter. Enumerations: entity, id
When no view parameter is provided, the API will return 204 - No Content with no response body.

Body Params
string

Unique identifier of the milestone.

string

Start date of the milestone. Format: date-time

[DateTime: yyyy-MM-ddTHH:mm:ssZ]

integer

RetrieveOnly. Number of days to complete the milestone.

boolean

Indicates whether the milestone has been completed.

loanAssociate
object

Object containing loan associate details found in the LoanAssociateContract.

boolean

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

integer

RetrieveOnly

string

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

string

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

string

RetrieveOnly. Name of the milestone set by the Encompass administrator.

milestoneSetting
object

RetrieveOnly. Object containing milestone settings details found in the EntityReferenceContract.

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…
Response
Choose an example:
application/json