V1 Manage Preliminary Comments

patch

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

Add or delete comments from a preliminary condition.

Path Params

loanId

string

required

The unique identifier assigned to a loan.

conditionId

string

required

The unique identifier assigned to the condition for which to add or remove comments.

Query Params

action

string

Action to perform. Possible values are:
add- Adds a comment.
remove - Deletes a comment.

view

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

commentId

string

Unique identifier of a comment.

comments

string

Any comments for the condition.

forRoleId

integer

Unique identifier of the role that this comment was assigned to. Example: 0

forRole

object

Information about the Encompass role ID that has access to this comment.

dateCreated

string

Date the comment was created.

createdBy

string

Encompass user ID of the user who created the comment.

createdByName

string

Name of the user who created the comment.

dateReviewed

string

Date the comment was reviewed.

reviewedBy

string

Encompass user ID of the user who reviewed the comment.

isExternal

boolean

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

201Created