Add/Edit loan alert

This request adds or edits a loan alert.

   Click here to learn more about this request

Loan alerts are messages that are displayed on the loan header and the Loan Summary tab of individual loans. Note the following when using this request:

Alerts consist of only a body, and they are used to display short messages about loans.

Alerts can be easily updated—simply add new text to the loanAlert field.

Deleting alerts works the same way as updating them. To delete a loan alert, remove all text from the loanAlert field. It will no longer display on the account.

For an example of how loan alerts work within the UI, take a look at our Loan Alerts article on our help site.

Database

For information on notes database tables, see the following articles:

Database – Notes Entity (note_entity)

Database – Loan Table (loan_entity)

{ "loanAlert": "This is an example of a loan alert." }
Path Params
int32
required

This is the ID of the loan.

Body Params
string

This determines what will be displayed in the loan alert.
> To remove a loan alert, leave this field blank in the payload.

Responses

Language
Credentials