V3 Manage Comments

patch

https://api.elliemae.com/encompass/v3/loans/{loanId}/conditions/{conditionId}/comments

Add, update, or delete comments from an enhanced condition.

Path Params

loanId

string

required

Unique identifier of the loan.

conditionId

string

required

Unique identifier of the condition in the loan.

Query Params

lockId

string

The unique identifier of the loan lock that has been obtained by the user.

action

string

Possible values are: Add, Update, and Delete.

Body Params

string

Unique ID associated with the comment. Example: "id": "ade11842-a02f-44d7-8554-5dcb7580e676"

comments

string

Comments associated with the condition.

forRole

object

The role for which the comment was added. See the EntityReferenceContract.

addedDate

string

RetrieveOnly. Date and time at which the comment was added. For example, 2022-01-24T22:11:53.648Z

addedBy

object

Information about the user who added the comment.

reviewedDate

string

RetrieveOnly. Date and time at which the comment was reviewed. For example, 2022-01-24T22:11:53.648Z

reviewedBy

object

Array of objects containing validation items as described in the EntityReferenceContract.

isExternal

boolean

Indicates whether the comment can be shown externally.

Headers

Authorization

string

required

Bearer token

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Language

URL

Loading…

Response

Choose an example:

application/json

200OK