Download Postman Collection
API Reference

Manage a Note

patch
https://api.elliemae.com/secondary/v1/trades/correspondent//notes

Updates or deletes a correspondent trade note.

Usage Notes

  • To delete a note, entityRemove attribute in the tradeNoteContract must be set to true.
  • To delete a note using this API, the caller must have persona access to edit correspondent trades. Access is enabled in Encompass > Settings > Personas > Trades/Contacts/Dashboard/Reports tab > Trades area by selecting the Edit Correspondent Trades check box.
  • When a note is updated or deleted from an existing correspondent trade, an event for “Trade Updated” is created in the correspondent trade history.
Path Params
string
required

Unique identifier of a correspondent trade. The TradeID and ID are the same.

Body Params
createdBy
object

EntityReferenceContract identifying the user who created the note.

date-time

Date and time the note was created.

string

Note text and details.

string

Unique identifier assigned to the note.

boolean

Indicator to delete the note.

string

Time zone abbreviation.

Headers
string

Bearer token

Response

Updated 29 days ago

Language
URL
Response 
 Choose an example:
application/json
Updated 29 days ago 


































© ICE Mortgage Technology, Inc. All rights reserved. Terms of Use